Skip to content

Commit

Permalink
remove all github page files
Browse files Browse the repository at this point in the history
  • Loading branch information
ereali-aneo committed Feb 12, 2025
1 parent 704d4a9 commit b6dba97
Show file tree
Hide file tree
Showing 22 changed files with 45 additions and 13,549 deletions.
3 changes: 0 additions & 3 deletions .docs/.markdownlintignore

This file was deleted.

2 changes: 0 additions & 2 deletions .docs/.npmrc

This file was deleted.

23 changes: 14 additions & 9 deletions .docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,31 @@ Docs for ArmoniK

## Installation

> Be aware to be in the .docs folder
> Be aware to be at the root of the repository
```bash
pnpm install
python -m venv .venv-doc
```

> If you don't have pnpm installed, you can install it with the following command: `npm install -g pnpm`
Then activate the virtual environment:

## Usage
```bash
source .venv-doc/bin/activate
```

To run the docs locally, run the following command:
And install dependencies:

```bash
pnpm run dev
pip install -r .docs/requirements.txt
```

To build the docs, run the following command:
## Usage

To build the docs locally, run the following command:

```bash
pnpm run generate
tools/generate-csharp-doc.sh
sphinx-build -M html .docs build
```

For more information, check out the [armonik-docs-theme documentation](https://aneoconsulting.github.io/armonik-docs-theme).
Outputs can be found in `build/html/index.html`.
14 changes: 0 additions & 14 deletions .docs/app.config.ts

This file was deleted.

20 changes: 0 additions & 20 deletions .docs/components/content/Mermaid.vue

This file was deleted.

4 changes: 3 additions & 1 deletion .docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@

templates_path = ["_templates"]
exclude_patterns = ["requirements.txt", "README.md"]
suppress_warnings = ["myst.header"]
suppress_warnings = ["myst.header", "misc.highlighting_failure"]

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_search = True


# -- Options for source files ------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-source-files
Expand Down
1 change: 1 addition & 0 deletions .docs/content/armonik/architecture-ArmoniK-internals.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .docs/content/armonik/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This project is an Open Source ([Apache 2.0 License](https://github.com/aneocons
```

Here is an overview of how Armonik works:
![Armonik overview diagram](/architecture-ArmoniK-internals.svg)
![Armonik overview diagram](./architecture-ArmoniK-internals.svg)

## When should I use ArmoniK

Expand Down
Binary file added .docs/content/user-guide/Debug-property.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .docs/content/user-guide/default-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ compute_plane = {
partition4 = {
worker = [{
image = "custom_worker"
tag = "0.1.0
tag = "0.1.0"
}]
}
}
Expand Down
4 changes: 2 additions & 2 deletions .docs/content/user-guide/how-to-configure-partitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Follow the HelloWorld tutorial [here](https://github.com/aneoconsulting/ArmoniK/
# ArmoniK workers
worker = [
{
image = hello
image = "hello"
tag = "latest"
limits = {
cpu = "1000m"
Expand Down Expand Up @@ -262,7 +262,7 @@ Follow the HelloWorld tutorial [here](https://github.com/aneoconsulting/ArmoniK/
{
type = "prometheus"
threshold = 2
},
}
]
}
},
Expand Down
2 changes: 1 addition & 1 deletion .docs/content/user-guide/how-to-configure-seq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
If you want to access outside your Kubernetes cluster, you have to configure Seq to make it accessible from the outside.
Edit the [parameters.tfvars](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/parameters.tfvars), and edit the `seq` section (or add it if not present). Add the `service_type` option:

```tfvars
```hcl
seq = {
service_type = "LoadBalancer"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ See the example [here](https://github.com/aneoconsulting/ArmoniK/blob/main/.docs

Open the Debug property and add as arguments using the command line:

```args
```bash
--endpoint "http://<ip>:5001" --partition <partition name>
```

Expand Down
19 changes: 0 additions & 19 deletions .docs/eslint.config.mjs

This file was deleted.

33 changes: 0 additions & 33 deletions .docs/nuxt.config.ts

This file was deleted.

28 changes: 0 additions & 28 deletions .docs/package.json

This file was deleted.

Loading

0 comments on commit b6dba97

Please sign in to comment.