Skip to content

Commit

Permalink
Merge pull request #64 from gisaia/doc/concept_links
Browse files Browse the repository at this point in the history
Update concept links to general doc concepts page
  • Loading branch information
WilliGautier authored Jan 30, 2025
2 parents b19e7be + f7c0ad2 commit cbec989
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 98 deletions.
90 changes: 0 additions & 90 deletions docs/docs/concepts.md

This file was deleted.

14 changes: 7 additions & 7 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# About arlas_cli

__ARLAS Command Line Interface__ (`arlas_cli`) is a tool to manage data and configurations in ARLAS.
__ARLAS Command Line Interface__ (`arlas_cli`) is a tool to manage data and [configurations](../static_docs/concepts/#arlas-cli-configuration) in ARLAS.

`arlas_cli` is a Python command line for:

- Managing [Elasticsearch indices](concepts.md#es-index):
- Generate an index mapping based on [NDJSON data](https://jsonlines.org/)
- Managing [Elasticsearch indices](../static_docs/concepts/#es-index):
- Generate an index mapping based on [NDJSON data](https://jsonlines.org/){:target="_blank"}
- Create an index
- List indices
- Describe an index
- Clone an index
- Migrate an index
- Delete an index
- Managing [ARLAS collections](concepts.md#arlas-collection)
- Managing [ARLAS collections](../static_docs/concepts/#arlas-collection)
- Create a collection
- List collections
- Describe a collection
- Delete a collection
- Managing [arlas_cli configurations](concepts.md#configuration)
- Managing [arlas_cli configurations](../static_docs/concepts/#arlas-cli-configuration)
- Register an ARLAS/Elasticsearch configuration, with headers and authentication parameters
- Login to your ARLAS Cloud account
- List your configurations
- Delete a configuration
- Managing [ARLAS Dashboards](concepts.md#arlas-dashboards) persistence
- Managing [ARLAS Dashboards](../static_docs/concepts/#arlas-dashboards) in persistence
- Create a dashboard from a configuration file
- List available dashboard
- Describe a dashboard
- Delete a dashboard
- Get the groups accessing dashboards
- Managing [ARLAS Identity and Access](concepts.md#arlas-iam) (ARLAS IAM)
- Managing [ARLAS Identity and Access](../static_docs/concepts/#arlas-iam) (ARLAS IAM)
- List organisations
- Add an organisation
- Within an organisation:
Expand Down
1 change: 0 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ nav:
- collections: collections.md
- persist: persist.md
- iam: iam.md
- Concepts: concepts.md

plugins:
- search
Expand Down

0 comments on commit cbec989

Please sign in to comment.