doc update

gisaia · Mar 8, 2024 · 6be40b0 · 6be40b0
1 parent 37c2b52
commit 6be40b0
Show file tree

Hide file tree

Showing 72 changed files with 5,140 additions and 195 deletions.
diff --git a/docs/docs/confs.md b/docs/docs/confs.md
@@ -56,6 +56,9 @@ An ARLAS Configuration tells `arlas_cli` how to contact ARLAS Server and elastic
 │ *  --server                                TEXT  ARLAS Server url  │
 │                                                  [default: None]   │
 │                                                  [required]        │
+│    --persistence                           TEXT  ARLAS Persistence │
+│                                                  url               │
+│                                                  [default: None]   │
 │    --headers                               TEXT  header            │
 │                                                  (name:value)      │
 │    --elastic                               TEXT  dictionary of     │

diff --git a/docs/docs/indices.md b/docs/docs/indices.md
@@ -68,11 +68,16 @@ To generate a mapping, you need to provide a NDJSON file (New line delimiter JSO
 > arlas_cli indices --config local create --help
                                                                       
  Usage: python -m arlas.cli.cli indices create [OPTIONS] INDEX        
+ [ADD_UUID]                                                           
                                                                       
  Create an index                                                      
                                                                       
 ╭─ Arguments ────────────────────────────────────────────────────────╮
-│ *    index      TEXT  index's name [default: None] [required]      │
+│ *    index         TEXT        index's name [default: None]        │
+│                                [required]                          │
+│      add_uuid      [ADD_UUID]  Set a UUID for the provided json    │
+│                                path field                          │
+│                                [default: None]                     │
 ╰────────────────────────────────────────────────────────────────────╯
 ╭─ Options ──────────────────────────────────────────────────────────╮
 │ *  --mapping        TEXT     Name of the mapping within your       │

diff --git a/docs/docs/started.md b/docs/docs/started.md
@@ -301,11 +301,9 @@ models:
 ```
 
 The `arlas` section contains the different deployment configurations. The mapping section lists the mapping template that you can use.
- Finally, the models are the templates for the collections. A [detailed description](docs/model/README.md) of the configuration structure is provided.
+ Finally, the models are the templates for the collections. A [detailed description](model/README.md) of the configuration structure is provided.
  
-
- ### Create, describe and delete a configuration for `arlas_cli`
-
+### Create, describe and delete a configuration for `arlas_cli`
 
 You can edit directly the `${HOME}/.arlas/cli/configuration.yaml` configuration file to update your configurations. You can also use the command line itself.
 

diff --git a/docs/docs/version.md b/docs/docs/version.md
@@ -1,2 +1,2 @@
 ARLAS Version:
-0.2.11
+0.3.0
diff --git a/docs/site/404.html b/docs/site/404.html
@@ -182,6 +182,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>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="/arlas_cli/." class="md-nav__link">
 
@@ -250,10 +270,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
 
 
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -264,8 +284,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_5">
             <span class="md-nav__icon md-icon"></span>
             Commands
           </label>
@@ -340,6 +360,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/arlas_cli/persist/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Persistence
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="/arlas_cli/confs/" class="md-nav__link">
 
@@ -369,11 +410,11 @@
 
 
     <li class="md-nav__item">
-      <a href="/arlas_cli/version/" class="md-nav__link">
+      <a href="/arlas_cli/model/model/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    arlas_cli version
+    Configuration data model
   </span>
 
 

diff --git a/docs/site/collections/index.html b/docs/site/collections/index.html
@@ -18,7 +18,7 @@
         <link rel="prev" href="../indices/">
 
 
-        <link rel="next" href="../confs/">
+        <link rel="next" href="../persist/">
 
 
       <link rel="icon" href="../assets/images/favicon.png">
@@ -193,6 +193,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href=".." class="md-nav__link">
 
@@ -263,10 +283,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
 
 
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -277,8 +297,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_4">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_5">
             <span class="md-nav__icon md-icon"></span>
             Commands
           </label>
@@ -416,6 +436,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../persist/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Persistence
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 
@@ -445,11 +486,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../version/" class="md-nav__link">
+      <a href="../model/model/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    arlas_cli version
+    Configuration data model
   </span>
 
 

diff --git a/docs/site/collections_1/index.html b/docs/site/collections_1/index.html
@@ -189,6 +189,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../version/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    arlas_cli version
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href=".." class="md-nav__link">
 
@@ -257,10 +277,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
 
 
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -271,8 +291,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_5">
             <span class="md-nav__icon md-icon"></span>
             Commands
           </label>
@@ -347,6 +367,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../persist/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Persistence
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 
@@ -376,11 +417,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../version/" class="md-nav__link">
+      <a href="../model/model/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    arlas_cli version
+    Configuration data model
   </span>