diff --git a/docs/docs/collections.md b/docs/docs/collections.md index 6ed2e84..4800168 100644 --- a/docs/docs/collections.md +++ b/docs/docs/collections.md @@ -10,7 +10,7 @@ ╭─ Options ──────────────────────────────────────────────────────────╮ │ * --config TEXT Name of the ARLAS configuration to use │ │ from your configuration file │ -│ (/Users/gaudan/.arlas/cli/configuration.… │ +│ (/Users/User/.arlas/cli/configuration.… │ │ [default: None] │ │ [required] │ │ --help Show this message and exit. │ @@ -63,16 +63,16 @@ You can create a collection from scratch or by providing a collection model (`-- │ [default: None] │ │ --orgs TEXT List of organisations │ │ accessing the collection │ -│ --id-path TEXT Overide the JSON path to │ +│ --id-path TEXT Override the JSON path to │ │ the id field. │ │ [default: None] │ -│ --centroid-path TEXT Overide the JSON path to │ +│ --centroid-path TEXT Override the JSON path to │ │ the centroid field. │ │ [default: None] │ -│ --geometry-path TEXT Overide the JSON path to │ +│ --geometry-path TEXT Override the JSON path to │ │ the geometry field. │ │ [default: None] │ -│ --date-path TEXT Overide the JSON path to │ +│ --date-path TEXT Override the JSON path to │ │ the date field. │ │ [default: None] │ │ --help Show this message and │ diff --git a/docs/docs/confs.md b/docs/docs/confs.md index 3c70740..f70e94d 100644 --- a/docs/docs/confs.md +++ b/docs/docs/confs.md @@ -38,7 +38,7 @@ It is possible, with the `arlas_cli` command line, to manage the ARLAS configura An ARLAS Configuration tells `arlas_cli` how to contact ARLAS Server and elasticsearch. It supports the addition of http headers. For ARLAS, keycloak and ARLAS IAM authentications are supported. Default is keycloak, use `--auth-arlas-iam` for ARLAS IAM. !!! danger - By default, it is not possible to run the `delete` command on an elasticsearch with `arlas_cli`. This is to prevent accidental data loass. In order to allow delete on a configuration, use the `--allow-delete` option. + By default, it is not possible to run the `delete` command on an elasticsearch with `arlas_cli`. This is to prevent accidental data loss. In order to allow delete on a configuration, use the `--allow-delete` option. ```shell diff --git a/docs/docs/indices.md b/docs/docs/indices.md index 4386485..4b38987 100644 --- a/docs/docs/indices.md +++ b/docs/docs/indices.md @@ -9,7 +9,7 @@ ╭─ Options ──────────────────────────────────────────────────────────╮ │ * --config TEXT Name of the ARLAS configuration to use │ │ from your configuration file │ -│ (/Users/gaudan/.arlas/cli/configuration.… │ +│ (/Users/User/.arlas/cli/configuration.… │ │ [default: None] │ │ [required] │ │ --help Show this message and exit. │ @@ -29,7 +29,7 @@ ## Generate mapping from a data file -To generate a mapping, you need to provide a NDJSON file (New line delimiter JSON). The first N lines are used for infering the mapping. If the mapping is wrong, you can overwrite the typing with the `--field-mapping` option. Once you're happy with the mapping, you can directly push it on elasticsearch (`--push-on`). +To generate a mapping, you need to provide a NDJSON file (New line delimiter JSON). The first N lines are used for inferring the mapping. If the mapping is wrong, you can overwrite the typing with the `--field-mapping` option. Once you're happy with the mapping, you can directly push it on elasticsearch (`--push-on`). ```shell @@ -40,8 +40,8 @@ To generate a mapping, you need to provide a NDJSON file (New line delimiter JSO Generate the mapping based on the data ╭─ Arguments ────────────────────────────────────────────────────────╮ -│ * file TEXT Path to the file conaining the data. Format: │ -│ NDJSON │ +│ * file TEXT Path to the file containing the data. │ +│ Format: NDJSON │ │ [default: None] │ │ [required] │ ╰────────────────────────────────────────────────────────────────────╯ @@ -50,7 +50,7 @@ To generate a mapping, you need to provide a NDJSON file (New line delimiter JSO │ generating the mapping. Avoid │ │ going over 10. │ │ [default: 2] │ -│ --field-mapping TEXT Overide the mapping with the │ +│ --field-mapping TEXT Override the mapping with the │ │ provided field/type. Example: │ │ fragment.location:geo_point │ │ --push-on TEXT Push the generated mapping for the │ @@ -89,7 +89,7 @@ To generate a mapping, you need to provide a NDJSON file (New line delimiter JSO ## Index data -For indexing data, you'll need to provide one ore several NDJSON file(s). Indexing uses bulks for optimal performances. +For indexing data, you'll need to provide one or several NDJSON file(s). Indexing uses bulks for optimal performances. ```shell @@ -101,8 +101,8 @@ For indexing data, you'll need to provide one ore several NDJSON file(s). Indexi ╭─ Arguments ────────────────────────────────────────────────────────╮ │ * index TEXT index's name [default: None] [required] │ -│ * files FILES... List of pathes to the file conaining the │ -│ data. Format: NDJSON │ +│ * files FILES... List of path's to the file containing │ +│ the data. Format: NDJSON │ │ [default: None] │ │ [required] │ ╰────────────────────────────────────────────────────────────────────╯ diff --git a/docs/docs/persist.md b/docs/docs/persist.md index 7a8bef5..3036ab0 100644 --- a/docs/docs/persist.md +++ b/docs/docs/persist.md @@ -11,7 +11,7 @@ ARLAS Persistence allows you to place files within zones. A zone is visible by g ╭─ Options ──────────────────────────────────────────────────────────╮ │ * --config TEXT Name of the ARLAS configuration to use │ │ from your configuration file │ -│ (/Users/gaudan/.arlas/cli/configuration.… │ +│ (/Users/User/.arlas/cli/configuration.… │ │ [default: None] │ │ [required] │ │ --help Show this message and exit. │ diff --git a/docs/docs/persist_1.md b/docs/docs/persist_1.md index 4988b07..728cd7c 100644 --- a/docs/docs/persist_1.md +++ b/docs/docs/persist_1.md @@ -1,4 +1,4 @@ -## Manage pesistence +## Manage persistence ARLAS Persistence allows you to place files within zones. A zone is visible by groups. It is also possible to set the access: writers, readers and whether it is public or not. diff --git a/docs/docs/started.md b/docs/docs/started.md index 8108f2d..1536f1b 100644 --- a/docs/docs/started.md +++ b/docs/docs/started.md @@ -8,7 +8,7 @@ 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 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. +`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 convenience 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. @@ -100,7 +100,7 @@ To add a specific mapping, it is possible to use the `create`` command: ### List indices ```shell -> arlas_cli indices --config local list --config local +> arlas_cli indices --config local list +----------+--------+-------+--------+ | name | status | count | size | +----------+--------+-------+--------+ @@ -112,14 +112,14 @@ To add a specific mapping, it is possible to use the `create`` command: ### Add data ```shell -> arlas_cli indices --config local data courses sample.json --config local +> arlas_cli indices --config local data courses sample.json ``` ### Describe an index ```shell -> arlas_cli indices --config local describe courses --config local +> arlas_cli indices --config local describe courses +----------------------------------------------------+-----------+ | field name | type | +----------------------------------------------------+-----------+ diff --git a/scripts/tests.sh b/scripts/tests.sh index c822ad0..76bb6eb 100755 --- a/scripts/tests.sh +++ b/scripts/tests.sh @@ -53,7 +53,7 @@ fi echo "TEST infer mapping and add mapping on ES" python3 -m arlas.cli.cli --config-file /tmp/arlas_cli.yaml indices --config tests mapping tests/sample.json --nb-lines 10 --field-mapping track.timestamps.center:date-epoch_second --field-mapping track.timestamps.start:date-epoch_second --field-mapping track.timestamps.end:date-epoch_second --push-on courses if [ "$? -eq 0" ] ; then - echo "OK: Mapping infered and added" + echo "OK: Mapping inferred and added" else echo "ERROR: infer mapping failed" exit 1