From 417f812b9483f436cc3e49087f12b880db66f1d0 Mon Sep 17 00:00:00 2001
From: Willi <willi.gautier@gisaia.com>
Date: Thu, 5 Dec 2024 16:12:38 +0100
Subject: [PATCH] Add --no-index option documentation in template

---
 docs/docs/indices.md.template | 36 +++++++++++++++++++++++++----------
 1 file changed, 26 insertions(+), 10 deletions(-)

diff --git a/docs/docs/indices.md.template b/docs/docs/indices.md.template
index 0ddbf95..cc7d717 100644
--- a/docs/docs/indices.md.template
+++ b/docs/docs/indices.md.template
@@ -35,15 +35,6 @@ The values of the first lines of the files are used to infer the mapping for eac
 
     Make sure to take enough rows to get all the fields with the option `--nb_lines`
 
-!!! tip
-    The data can be split in different NDJSON files in a folder:
-    ```
-    part-00000-[...].json
-    part-00001-[...].json
-    ...
-    ```
-    In practice, the `file` Argument can be filed with a **pattern** such as `path/to/data.json/part-0000*.json` to reference all the different files.
-
 
 ### Type identification
 
@@ -85,7 +76,7 @@ A **date** is identified as such if
 
 By default, the keywords and text fields are searchable as fulltext to be accessible in the search bar.
 
-!!! note "--no-fulltext "
+!!! note "--no-fulltext"
 
     If searching through a field value is not needed, it can be deactivated.
     That would result in better performances for the fulltext search.
@@ -94,6 +85,17 @@ By default, the keywords and text fields are searchable as fulltext to be access
 
     - `--no-fulltext field_keyword`
 
+!!! note "--no-index"
+    If a field doesn't need to be explored in the dashboard, it should be removed before indexing the data.
+
+    Alternatively, you can explicitly exclude the field from being indexed using the `--no-index` option.
+
+    Example:
+
+    - `--no-index unused_field`
+
+    The field will remain in the data but will not be indexed.
+
 ### Created mapping
 
 By default, the `arlas_cli indices mapping` directly returns the mapping in the command line.
@@ -144,6 +146,11 @@ The `indices create` sub-function create the index from a mapping json file.
 
 The index name and the path to the mapping json file have to be used to create the ES index.
 
+!!! warning
+    If the ARLAS deployment uses ARLAS IAM for authentication, the index must be associated with an organisation.
+
+    The `index_name` must follow the pattern `{organisation}@{data_index_name}` (e.g., `gisaia.com@ais_courses`).
+
 The `indices create` sub-function create the index from a mapping json file.
 
 Example:
@@ -180,6 +187,15 @@ Example:
    data {index_name} {path/to/data.json}
 ```
 
+!!! tip
+    The data can be split in different NDJSON files in a folder:
+    ```
+    part-00000-[...].json
+    part-00001-[...].json
+    ...
+    ```
+    In practice, the `files` argument can be filed with a **pattern** such as `path/to/data.json/part-0000*.json` to reference all the different files.
+
 !!! warning
     If the index already contains data, the data is added to the index.