Merge pull request #3 from gisaia/bug/doc

fix doc
gisaia · Feb 19, 2024 · 77a2c43 · 77a2c43
2 parents a207fe8 + 5fcc484
commit 77a2c43
Show file tree

Hide file tree

Showing 67 changed files with 915 additions and 17 deletions.
diff --git a/docs/model/README.md → docs/docs/model/README.md b/docs/model/README.md → docs/docs/model/README.md
diff --git a/...arlas-properties-arlas-iam-url-anyof-1.md → ...arlas-properties-arlas-iam-url-anyof-1.md b/...arlas-properties-arlas-iam-url-anyof-1.md → ...arlas-properties-arlas-iam-url-anyof-1.md
diff --git a/...el-defs-arlas-properties-arlas-iam-url.md → ...el-defs-arlas-properties-arlas-iam-url.md b/...el-defs-arlas-properties-arlas-iam-url.md → ...el-defs-arlas-properties-arlas-iam-url.md
diff --git a/...del-defs-arlas-properties-arlas-server.md → ...del-defs-arlas-properties-arlas-server.md b/...del-defs-arlas-properties-arlas-server.md → ...del-defs-arlas-properties-arlas-server.md
diff --git a/...dictionary-of-namees-resources-anyof-1.md → ...dictionary-of-namees-resources-anyof-1.md b/...dictionary-of-namees-resources-anyof-1.md → ...dictionary-of-namees-resources-anyof-1.md
diff --git a/...perties-dictionary-of-namees-resources.md → ...perties-dictionary-of-namees-resources.md b/...perties-dictionary-of-namees-resources.md → ...perties-dictionary-of-namees-resources.md
diff --git a/...allowed-for-this-configuration-anyof-0.md → ...allowed-for-this-configuration-anyof-0.md b/...allowed-for-this-configuration-anyof-0.md → ...allowed-for-this-configuration-anyof-0.md
diff --git a/...allowed-for-this-configuration-anyof-1.md → ...allowed-for-this-configuration-anyof-1.md b/...allowed-for-this-configuration-anyof-1.md → ...allowed-for-this-configuration-anyof-1.md
diff --git a/...command-allowed-for-this-configuration.md → ...command-allowed-for-this-configuration.md b/...command-allowed-for-this-configuration.md → ...command-allowed-for-this-configuration.md
diff --git a/...-arlas-properties-keycloak-url-anyof-1.md → ...-arlas-properties-keycloak-url-anyof-1.md b/...-arlas-properties-keycloak-url-anyof-1.md → ...-arlas-properties-keycloak-url-anyof-1.md
diff --git a/...del-defs-arlas-properties-keycloak-url.md → ...del-defs-arlas-properties-keycloak-url.md b/...del-defs-arlas-properties-keycloak-url.md → ...del-defs-arlas-properties-keycloak-url.md
diff --git a/docs/model/model-defs-arlas.md → docs/docs/model/model-defs-arlas.md b/docs/model/model-defs-arlas.md → docs/docs/model/model-defs-arlas.md
diff --git a/...onservice-properties-client-id-anyof-0.md → ...onservice-properties-client-id-anyof-0.md b/...onservice-properties-client-id-anyof-0.md → ...onservice-properties-client-id-anyof-0.md
diff --git a/...onservice-properties-client-id-anyof-1.md → ...onservice-properties-client-id-anyof-1.md b/...onservice-properties-client-id-anyof-1.md → ...onservice-properties-client-id-anyof-1.md
diff --git a/...horizationservice-properties-client-id.md → ...horizationservice-properties-client-id.md b/...horizationservice-properties-client-id.md → ...horizationservice-properties-client-id.md
diff --git a/...rvice-properties-client-secret-anyof-0.md → ...rvice-properties-client-secret-anyof-0.md b/...rvice-properties-client-secret-anyof-0.md → ...rvice-properties-client-secret-anyof-0.md
diff --git a/...rvice-properties-client-secret-anyof-1.md → ...rvice-properties-client-secret-anyof-1.md b/...rvice-properties-client-secret-anyof-1.md → ...rvice-properties-client-secret-anyof-1.md
diff --git a/...zationservice-properties-client-secret.md → ...zationservice-properties-client-secret.md b/...zationservice-properties-client-secret.md → ...zationservice-properties-client-secret.md
diff --git a/...perties-grant-type-eg-password-anyof-0.md → ...perties-grant-type-eg-password-anyof-0.md b/...perties-grant-type-eg-password-anyof-0.md → ...perties-grant-type-eg-password-anyof-0.md
diff --git a/...perties-grant-type-eg-password-anyof-1.md → ...perties-grant-type-eg-password-anyof-1.md b/...perties-grant-type-eg-password-anyof-1.md → ...perties-grant-type-eg-password-anyof-1.md
diff --git a/...vice-properties-grant-type-eg-password.md → ...vice-properties-grant-type-eg-password.md b/...vice-properties-grant-type-eg-password.md → ...vice-properties-grant-type-eg-password.md
diff --git a/...ies-is-it-an-arlas-iam-service-anyof-0.md → ...ies-is-it-an-arlas-iam-service-anyof-0.md b/...ies-is-it-an-arlas-iam-service-anyof-0.md → ...ies-is-it-an-arlas-iam-service-anyof-0.md
diff --git a/...ies-is-it-an-arlas-iam-service-anyof-1.md → ...ies-is-it-an-arlas-iam-service-anyof-1.md b/...ies-is-it-an-arlas-iam-service-anyof-1.md → ...ies-is-it-an-arlas-iam-service-anyof-1.md
diff --git a/...-properties-is-it-an-arlas-iam-service.md → ...-properties-is-it-an-arlas-iam-service.md b/...-properties-is-it-an-arlas-iam-service.md → ...-properties-is-it-an-arlas-iam-service.md
diff --git a/...-authorizationservice-properties-login.md → ...-authorizationservice-properties-login.md b/...-authorizationservice-properties-login.md → ...-authorizationservice-properties-login.md
diff --git a/...thorizationservice-properties-password.md → ...thorizationservice-properties-password.md b/...thorizationservice-properties-password.md → ...thorizationservice-properties-password.md
diff --git a/...oken-url-of-the-authentication-service.md → ...oken-url-of-the-authentication-service.md b/...oken-url-of-the-authentication-service.md → ...oken-url-of-the-authentication-service.md
diff --git a/.../model/model-defs-authorizationservice.md → .../model/model-defs-authorizationservice.md b/.../model/model-defs-authorizationservice.md → .../model/model-defs-authorizationservice.md
diff --git a/...ource-properties-file-or-http-location.md → ...ource-properties-file-or-http-location.md b/...ource-properties-file-or-http-location.md → ...ource-properties-file-or-http-location.md
diff --git a/...-requests-anyof-0-additionalproperties.md → ...-requests-anyof-0-additionalproperties.md b/...-requests-anyof-0-additionalproperties.md → ...-requests-anyof-0-additionalproperties.md
diff --git a/...s-if-needed-for-https-requests-anyof-0.md → ...s-if-needed-for-https-requests-anyof-0.md b/...s-if-needed-for-https-requests-anyof-0.md → ...s-if-needed-for-https-requests-anyof-0.md
diff --git a/...s-if-needed-for-https-requests-anyof-1.md → ...s-if-needed-for-https-requests-anyof-1.md b/...s-if-needed-for-https-requests-anyof-1.md → ...s-if-needed-for-https-requests-anyof-1.md
diff --git a/...f-headers-if-needed-for-https-requests.md → ...f-headers-if-needed-for-https-requests.md b/...f-headers-if-needed-for-https-requests.md → ...f-headers-if-needed-for-https-requests.md
diff --git a/docs/model/model-defs-resource.md → docs/docs/model/model-defs-resource.md b/docs/model/model-defs-resource.md → docs/docs/model/model-defs-resource.md
diff --git a/docs/model/model-defs.md → docs/docs/model/model-defs.md b/docs/model/model-defs.md → docs/docs/model/model-defs.md
diff --git a/...dictionary-of-namearlas-configurations.md → ...dictionary-of-namearlas-configurations.md b/...dictionary-of-namearlas-configurations.md → ...dictionary-of-namearlas-configurations.md
diff --git a/...es-dictionary-of-namemapping-resources.md → ...es-dictionary-of-namemapping-resources.md b/...es-dictionary-of-namemapping-resources.md → ...es-dictionary-of-namemapping-resources.md
diff --git a/...ties-dictionary-of-namemodel-resources.md → ...ties-dictionary-of-namemodel-resources.md b/...ties-dictionary-of-namemodel-resources.md → ...ties-dictionary-of-namemodel-resources.md
diff --git a/docs/model/model.md → docs/docs/model/model.md b/docs/model/model.md → docs/docs/model/model.md
diff --git a/docs/model/model.schema.json → docs/docs/model/model.schema.json b/docs/model/model.schema.json → docs/docs/model/model.schema.json
diff --git a/docs/docs/started.md b/docs/docs/started.md
@@ -8,10 +8,10 @@ Install `arlas_cli` ([prerequisite](install.md#Prerequisite))
     For running the various examples bellow, ARLAS and elasticsearch must be running on the local machine.
 
 ## Initial configuration
-`arlas_cli` uses a yaml file for storing various ARLAS and elasicsearch configurations. By default, the file is located in `~/.arlas/cli/configuration.yaml`. [One is automatically created for your convinience at the first launch](https://raw.githubusercontent.com/gisaia/arlas-cli/master/configuration.yaml). It contains the ARLAS demo endpoint and the local ARLAS and elasticsearch endpoints.
+`arlas_cli` uses a yaml file for storing various ARLAS and elasticsearch configurations. By default, the file is located in `~/.arlas/cli/configuration.yaml`. [One is automatically created for your convinience at the first launch](https://raw.githubusercontent.com/gisaia/arlas-cli/master/configuration.yaml). It contains the ARLAS demo endpoint and the local ARLAS and elasticsearch endpoints.
 
 The configuration can also contain references to collection models for creating collections. A default one is provided for ARLAS EO. A reference can be an http url or a path to a local file.
-It can also contain references to index mappings for creating indices. A default one is provided for ARLAS EO. A reference can be an http url or a path to a local file.
+It can also contain references to index mappings for creating indices. A default one is provided for ARLAS EO.
 
 ## Running
 
@@ -20,27 +20,28 @@ It can also contain references to index mappings for creating indices. A default
 > arlas_cli --version
 0.2.8
 Warning : no configuration file found, we created an empty one for 
-you (/Users/gaudan/.arlas/cli/configuration.yaml).
+you (~/.arlas/cli/configuration.yaml).
 ```
 
 ## Examples
 
 In the following examples, you will see how to:
+
 - generate an elasticsearch mapping based on json objects
 - add the mapping in elasticsearch
 - list the elasticsearch indices
 - add (index) data in the elasticsearch index
 - get the structure of the mapping
-- add a collection in arlas
-- list the arlas collection
-- get the structure of a arlas collection
-- delete a collection from arlas
+- add a collection in ARLAS
+- list the ARLAS collections
+- get the structure of a ARLAS collection
+- delete a collection from ARLAS
 - delete a mapping from elasticsearch
 - list, create, describe and delete a configuration for `arlas_cli`
 
 ... with the `arlas_cli` command line only!
 
-We suppose you hava an elasticsearch and arlas server running.
+We suppose you have an elasticsearch and arlas server running.
 
 ### Generate the elasticsearch mapping
 
@@ -71,12 +72,14 @@ Note that the three timestamps are not identified as datetimes by `arlas_cli`. T
 #### Type identification
 
 A geometry is identified as such if
+
 - it is a geojson
 - it is a WKT string
-- the fielf name contains `geohash`
+- the field name contains `geohash`
 - it is a string containing two float seperated by a comma
 
 A date is identified as such if
+
 - its name is one of `timestamp`, `date`, `start` or `end` and that it can be parsed as a date
 - its name contains `timestamp`, `date`, `start` or `end` and its values are number within [631152000, 4102444800] or [631152000000, 4102444800000] (year 1990 to 2100)
 
@@ -219,7 +222,7 @@ models:
 ```
 
 The `arlas` section contains the different deployment configurations. The mapping section lists the mapping template that you can use.
- Finaly, the models are the templates for the collections. A [detaild description](docs/model/README.md) of the configuration structure is provided.
+ Finally, the models are the templates for the collections. A [detailed description](docs/model/README.md) of the configuration structure is provided.
 
 
  ### Create, describe and delete a configuration for `arlas_cli`

diff --git a/docs/docs/version.md b/docs/docs/version.md
@@ -1,2 +1,2 @@
 ARLAS Version:
-0.2.8
+0.2.9
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
     accent: 'light-blue'
 
 nav:
+- arlas_cli version: version.md
 - About arlas_cli: index.md
 - Installation: install.md
 - Getting started: started.md
@@ -35,7 +36,7 @@ nav:
   - Indices: indices.md
   - Collections: collections.md
   - Configurations: confs.md
-- arlas_cli version: version.md
+- Configuration data model: model/model.md
 
 
 plugins:

diff --git a/docs/site/404.html b/docs/site/404.html
@@ -362,6 +362,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/arlas_cli/version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/collections/index.html b/docs/site/collections/index.html
@@ -438,6 +438,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/collections_1/index.html b/docs/site/collections_1/index.html
@@ -369,6 +369,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/collections_2/index.html b/docs/site/collections_2/index.html
@@ -369,6 +369,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/collections_3/index.html b/docs/site/collections_3/index.html
@@ -369,6 +369,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/collections_4/index.html b/docs/site/collections_4/index.html
@@ -364,6 +364,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/confs/index.html b/docs/site/confs/index.html
@@ -18,6 +18,8 @@
         <link rel="prev" href="../collections/">
 
 
+        <link rel="next" href="../version/">
+
 
       <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.9">
@@ -427,6 +429,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>
@@ -492,7 +514,7 @@ <h1>Configurations</h1>
 </div>
 <div class="admonition bug">
 <p class="admonition-title">Bug</p>
-<p>If you used the ARLAS Exploration Stack, it is possible that you already have a directory named <code>$HOME/.arlas</code>. This directory has been created by docker as root. The owner of the directory must be changed to the local user (<code>chown ${USER}: $HOME/.arlas</code>).</p>
+<p>If you used the ARLAS Exploration Stack, it is possible that you already have a directory named <code>$HOME/.arlas</code>. This directory has been created by docker as root. The owner of the directory must be changed to the local user (<code>sudo chown ${USER}: $HOME/.arlas</code>).</p>
 </div>
 <h2 id="list-configuration-management-commands">List configuration management commands</h2>
 <div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli confs --help</span><span data-ty>                                                                      <br> Usage: python -m arlas.cli.cli confs [OPTIONS] COMMAND [ARGS]...     <br>                                                                      <br>╭─ Options ──────────────────────────────────────────────────────────╮<br>│ --help          Show this message and exit.                        │<br>╰────────────────────────────────────────────────────────────────────╯<br>╭─ Commands ─────────────────────────────────────────────────────────╮<br>│ create             Add a configuration                             │<br>│ delete             Delete a configuration                          │<br>│ describe           Describe a configuration                        │<br>│ list               List configurations                             │<br>╰────────────────────────────────────────────────────────────────────╯<br><br></span></div>

diff --git a/docs/site/confs_1/index.html b/docs/site/confs_1/index.html
@@ -369,6 +369,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>
@@ -425,7 +445,7 @@ <h1>Confs 1</h1>
 </div>
 <div class="admonition bug">
 <p class="admonition-title">Bug</p>
-<p>If you used the ARLAS Exploration Stack, it is possible that you already have a directory named <code>$HOME/.arlas</code>. This directory has been created by docker as root. The owner of the directory must be changed to the local user (<code>chown ${USER}: $HOME/.arlas</code>).</p>
+<p>If you used the ARLAS Exploration Stack, it is possible that you already have a directory named <code>$HOME/.arlas</code>. This directory has been created by docker as root. The owner of the directory must be changed to the local user (<code>sudo chown ${USER}: $HOME/.arlas</code>).</p>
 </div>
 <h2 id="list-configuration-management-commands">List configuration management commands</h2>
 <p>```shell</p>

diff --git a/docs/site/confs_2/index.html b/docs/site/confs_2/index.html
@@ -369,6 +369,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/docs/site/confs_3/index.html b/docs/site/confs_3/index.html
@@ -364,6 +364,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>