Complete CLI docs. (#1029)

* Complete CLI docs.

* Update docs/reference/cli.md

Co-authored-by: PSeitz <[email protected]>

* Update docs/reference/cli.md

Co-authored-by: PSeitz <[email protected]>

* Improve CLI wording/examples.

* Update CONTRIBUTING.md

Co-authored-by: Evance Soumaoro <[email protected]>

* Update docs/reference/cli.md

Co-authored-by: Evance Soumaoro <[email protected]>

Co-authored-by: PSeitz <[email protected]>
Co-authored-by: Evance Soumaoro <[email protected]>

Author: 3 people

CONTRIBUTING.md

@@ -55,3 +55,27 @@ We also have nightly builds that are pushed to dockerhub. This helps continiousl
 ## Testing release (alpha, beta, rc)
 
 The following Quickwit installation command `curl -L https://install.quickwit.io | sh` always installs the latest stable version of quickwit. To make it easier in installing and testing new (alpha, beta, rc) releases, you can manually pull and execute the script as `./install.sh --allow-any-latest-version`. This will force the script to install any latest available release package.
+
+
+# Documentation
+
+Quickwit documentation is located in the docs directory.
+
+## Generating the CLI docs.
+
+The [CLI doc page](docs/reference/cli.md) is partly generated by a script.
+To update it, first run the script:
+```bash
+cargo run --bin generate_markdown > docs/reference/cli_insert.md
+```
+
+Then manually edit the [doc page](docs/reference/cli.md) to update it.
+I put two comments to indicate where you want to insert the new docs and where it ends:`
+```markdown
+[comment]: <> (Insert auto generated CLI docs from here.)
+
+...docs to insert...
+
+[comment]: <> (End of auto generated CLI docs.)
+```
+

config/tutorials/gh-archive/index-config.yaml

@@ -3,6 +3,8 @@
 #
 version: 0
 
+index_id: gh-archive
+
 doc_mapping:
   store_source: false
   field_mappings:

config/tutorials/hdfs-logs/index-config.yaml

@@ -4,6 +4,8 @@
 
 version: 0
 
+index_id: hdfs-logs
+
 doc_mapping:
   field_mappings:
     - name: timestamp

config/tutorials/wikipedia/index-config.yaml

@@ -4,6 +4,8 @@
 
 version: 0
 
+index_id: wikipedia
+
 doc_mapping:
   field_mappings:
     - name: title

docs/get-started/installation.md

@@ -91,7 +91,7 @@ curl -o wikipedia_index_config.yaml https://raw.githubusercontent.com/quickwit-i
 curl -o wiki-articles-10000.json https://quickwit-datasets-public.s3.amazonaws.com/wiki-articles-10000.json
 
 # create, index and search using the container 
-docker run -v "$(pwd)":"/quickwit/qwdata" quickwit/quickwit index create --index wikipedia --index-config ./qwdata/wikipedia_index_config.yaml
+docker run -v "$(pwd)":"/quickwit/qwdata" quickwit/quickwit index create --index-config ./qwdata/wikipedia_index_config.yaml
 
 docker run -v "$(pwd)":"/quickwit/qwdata" quickwit/quickwit index ingest --index wikipedia --input-path ./qwdata/wiki-articles-10000.json
 

docs/get-started/quickstart.md

@@ -80,7 +80,7 @@ export QW_CONFIG=./config/quickwit.yaml
 Now we can create the index with the command:
 
 ```bash
-./quickwit index create --index wikipedia --index-config ./wikipedia_index_config.yaml
+./quickwit index create --index-config ./wikipedia_index_config.yaml
 ```
 
 Check that a directory `./qwdata/wikipedia` has been created, Quickwit will write index files here and a `quickwit.json` which contains the [index metadata](../overview/architecture.md#index-metadata).
@@ -155,7 +155,7 @@ Run the following command from within Quickwit's installation directory.
 ```bash
 curl -o wikipedia_index_config.yaml https://raw.githubusercontent.com/quickwit-inc/quickwit/main/config/tutorials/wikipedia/index-config.yaml
 export QW_CONFIG=./config/quickwit.yaml
-./quickwit index create --index wikipedia --index-config ./wikipedia_index_config.yaml
+./quickwit index create --index-config ./wikipedia_index_config.yaml
 curl -o wiki-articles-10000.json https://quickwit-datasets-public.s3.amazonaws.com/wiki-articles-10000.json
 ./quickwit index ingest --index wikipedia --input-path ./wiki-articles-10000.json
 ./quickwit index search --index wikipedia --query "barack AND obama"

docs/guides/add-full-text-search-to-your-olap-db.md

@@ -80,7 +80,7 @@ search_settings:
 
 ```bash
 curl -o gh-archive-index-config.yaml https://raw.githubusercontent.com/quickwit-inc/quickwit/main/config/tutorials/gh-archive/index-config.yaml
-./quickwit index create --index gh-archive --index-config gh-archive-index-config.yaml
+./quickwit index create --index-config gh-archive-index-config.yaml
 ```
 
 ## Indexing events

docs/guides/tutorial-hdfs-logs-distributed-search-aws-s3.md

@@ -81,7 +81,7 @@ export S3_PATH=s3://{path/to/bucket}/indexes
 ```
 
 ```bash
-# configuration for our indexer node
+# Create Quickwit config file.
 echo "version: 0
 metastore_uri: ${S3_PATH}
 default_index_root_uri: ${S3_PATH}
@@ -91,7 +91,7 @@ default_index_root_uri: ${S3_PATH}
 We can now create the index with the `create` subcommand.
 
 ```bash
-./quickwit index create --index hdfslogs --index-config ./hdfslogs_index_config.yaml --config ./config.yaml
+./quickwit index create --index-config hdfslogs_index_config.yaml --config config.yaml
 ```
 
 :::note

docs/guides/tutorial-hdfs-logs.md

@@ -86,7 +86,7 @@ export QW_CONFIG=./config/quickwit.yaml
 ```
 
 ```bash
-./quickwit index create --index hdfslogs --index-config ./hdfslogs_index_config.yaml
+./quickwit index create --index-config hdfslogs_index_config.yaml
 ```
 
 You're now ready to fill the index.