Skip to content

Commit

Permalink
Merge pull request #13 from gisaia/feat/fix_doc_spellings
Browse files Browse the repository at this point in the history 
Fix spelling in doc
  • Loading branch information
@sylvaingaudan
sylvaingaudan authored Jul 26, 2024
2 parents b631313 + 26220f2 commit 1726eb9
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
10 changes: 5 additions & 5 deletions docs/docs/collections.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. │
Expand Down Expand Up @@ -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 │
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/confs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- termynal -->
```shell
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/indices.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. │
Expand All @@ -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`).
<!-- termynal -->
```shell
Expand All @@ -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] │
╰────────────────────────────────────────────────────────────────────╯
Expand All @@ -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 │
Expand Down Expand Up @@ -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.
<!-- termynal -->
```shell
Expand All @@ -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] │
╰────────────────────────────────────────────────────────────────────╯
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/persist.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. │
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/persist_1.md
View file
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -100,7 +100,7 @@ To add a specific mapping, it is possible to use the `create`` command:
### List indices
<!-- termynal -->
```shell
> arlas_cli indices --config local list --config local
> arlas_cli indices --config local list
+----------+--------+-------+--------+
| name | status | count | size |
+----------+--------+-------+--------+
Expand All @@ -112,14 +112,14 @@ To add a specific mapping, it is possible to use the `create`` command:
### Add data
<!-- termynal -->
```shell
> arlas_cli indices --config local data courses sample.json --config local
> arlas_cli indices --config local data courses sample.json
```

### Describe an index

<!-- termynal -->
```shell
> arlas_cli indices --config local describe courses --config local
> arlas_cli indices --config local describe courses
+----------------------------------------------------+-----------+
| field name | type |
+----------------------------------------------------+-----------+
Expand Down
2 changes: 1 addition & 1 deletion scripts/tests.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1726eb9

Please sign in to comment.