From 5fcc484f150b0eb5b19d060c820e5f0cb34e220f Mon Sep 17 00:00:00 2001 From: Sylvain Gaudan Date: Mon, 19 Feb 2024 16:19:09 +0100 Subject: [PATCH] fix doc --- docs/{ => docs}/model/README.md | 0 ...-arlas-properties-arlas-iam-url-anyof-1.md | 0 ...del-defs-arlas-properties-arlas-iam-url.md | 0 ...odel-defs-arlas-properties-arlas-server.md | 0 ...-dictionary-of-namees-resources-anyof-1.md | 0 ...operties-dictionary-of-namees-resources.md | 0 ...-allowed-for-this-configuration-anyof-0.md | 0 ...-allowed-for-this-configuration-anyof-1.md | 0 ...-command-allowed-for-this-configuration.md | 0 ...s-arlas-properties-keycloak-url-anyof-1.md | 0 ...odel-defs-arlas-properties-keycloak-url.md | 0 docs/{ => docs}/model/model-defs-arlas.md | 0 ...ionservice-properties-client-id-anyof-0.md | 0 ...ionservice-properties-client-id-anyof-1.md | 0 ...thorizationservice-properties-client-id.md | 0 ...ervice-properties-client-secret-anyof-0.md | 0 ...ervice-properties-client-secret-anyof-1.md | 0 ...izationservice-properties-client-secret.md | 0 ...operties-grant-type-eg-password-anyof-0.md | 0 ...operties-grant-type-eg-password-anyof-1.md | 0 ...rvice-properties-grant-type-eg-password.md | 0 ...ties-is-it-an-arlas-iam-service-anyof-0.md | 0 ...ties-is-it-an-arlas-iam-service-anyof-1.md | 0 ...e-properties-is-it-an-arlas-iam-service.md | 0 ...s-authorizationservice-properties-login.md | 0 ...uthorizationservice-properties-password.md | 0 ...token-url-of-the-authentication-service.md | 0 .../model/model-defs-authorizationservice.md | 0 ...source-properties-file-or-http-location.md | 0 ...s-requests-anyof-0-additionalproperties.md | 0 ...rs-if-needed-for-https-requests-anyof-0.md | 0 ...rs-if-needed-for-https-requests-anyof-1.md | 0 ...of-headers-if-needed-for-https-requests.md | 0 docs/{ => docs}/model/model-defs-resource.md | 0 docs/{ => docs}/model/model-defs.md | 0 ...-dictionary-of-namearlas-configurations.md | 0 ...ies-dictionary-of-namemapping-resources.md | 0 ...rties-dictionary-of-namemodel-resources.md | 0 docs/{ => docs}/model/model.md | 0 docs/{ => docs}/model/model.schema.json | 0 docs/docs/started.md | 23 +- docs/docs/version.md | 2 +- docs/mkdocs.yml | 3 +- docs/site/404.html | 20 + docs/site/collections/index.html | 20 + docs/site/collections_1/index.html | 20 + docs/site/collections_2/index.html | 20 + docs/site/collections_3/index.html | 20 + docs/site/collections_4/index.html | 20 + docs/site/confs/index.html | 24 +- docs/site/confs_1/index.html | 22 +- docs/site/confs_2/index.html | 20 + docs/site/confs_3/index.html | 20 + docs/site/help/index.html | 20 + docs/site/index.html | 20 + docs/site/indices/index.html | 20 + docs/site/indices_1/index.html | 20 + docs/site/indices_2/index.html | 20 + docs/site/indices_3/index.html | 20 + docs/site/indices_4/index.html | 20 + docs/site/indices_5/index.html | 20 + docs/site/install/index.html | 20 + docs/site/sitemap.xml | 5 + docs/site/sitemap.xml.gz | Bin 300 -> 305 bytes docs/site/started/index.html | 20 + docs/site/version/index.html | 487 ++++++++++++++++++ scripts/release.sh | 6 +- 67 files changed, 915 insertions(+), 17 deletions(-) rename docs/{ => docs}/model/README.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-arlas-iam-url-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-arlas-iam-url.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-arlas-server.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-dictionary-of-namees-resources.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-keycloak-url-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-arlas-properties-keycloak-url.md (100%) rename docs/{ => docs}/model/model-defs-arlas.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-client-id-anyof-0.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-client-id-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-client-id.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-client-secret-anyof-0.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-client-secret-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-client-secret.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-grant-type-eg-password.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-login.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-password.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service.md (100%) rename docs/{ => docs}/model/model-defs-authorizationservice.md (100%) rename docs/{ => docs}/model/model-defs-resource-properties-file-or-http-location.md (100%) rename docs/{ => docs}/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties.md (100%) rename docs/{ => docs}/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0.md (100%) rename docs/{ => docs}/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1.md (100%) rename docs/{ => docs}/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests.md (100%) rename docs/{ => docs}/model/model-defs-resource.md (100%) rename docs/{ => docs}/model/model-defs.md (100%) rename docs/{ => docs}/model/model-properties-dictionary-of-namearlas-configurations.md (100%) rename docs/{ => docs}/model/model-properties-dictionary-of-namemapping-resources.md (100%) rename docs/{ => docs}/model/model-properties-dictionary-of-namemodel-resources.md (100%) rename docs/{ => docs}/model/model.md (100%) rename docs/{ => docs}/model/model.schema.json (100%) create mode 100644 docs/site/version/index.html diff --git a/docs/model/README.md b/docs/docs/model/README.md similarity index 100% rename from docs/model/README.md rename to docs/docs/model/README.md diff --git a/docs/model/model-defs-arlas-properties-arlas-iam-url-anyof-1.md b/docs/docs/model/model-defs-arlas-properties-arlas-iam-url-anyof-1.md similarity index 100% rename from docs/model/model-defs-arlas-properties-arlas-iam-url-anyof-1.md rename to docs/docs/model/model-defs-arlas-properties-arlas-iam-url-anyof-1.md diff --git a/docs/model/model-defs-arlas-properties-arlas-iam-url.md b/docs/docs/model/model-defs-arlas-properties-arlas-iam-url.md similarity index 100% rename from docs/model/model-defs-arlas-properties-arlas-iam-url.md rename to docs/docs/model/model-defs-arlas-properties-arlas-iam-url.md diff --git a/docs/model/model-defs-arlas-properties-arlas-server.md b/docs/docs/model/model-defs-arlas-properties-arlas-server.md similarity index 100% rename from docs/model/model-defs-arlas-properties-arlas-server.md rename to docs/docs/model/model-defs-arlas-properties-arlas-server.md diff --git a/docs/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1.md b/docs/docs/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1.md similarity index 100% rename from docs/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1.md rename to docs/docs/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1.md diff --git a/docs/model/model-defs-arlas-properties-dictionary-of-namees-resources.md b/docs/docs/model/model-defs-arlas-properties-dictionary-of-namees-resources.md similarity index 100% rename from docs/model/model-defs-arlas-properties-dictionary-of-namees-resources.md rename to docs/docs/model/model-defs-arlas-properties-dictionary-of-namees-resources.md diff --git a/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0.md b/docs/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0.md similarity index 100% rename from docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0.md rename to docs/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0.md diff --git a/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1.md b/docs/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1.md similarity index 100% rename from docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1.md rename to docs/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1.md diff --git a/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration.md b/docs/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration.md similarity index 100% rename from docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration.md rename to docs/docs/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration.md diff --git a/docs/model/model-defs-arlas-properties-keycloak-url-anyof-1.md b/docs/docs/model/model-defs-arlas-properties-keycloak-url-anyof-1.md similarity index 100% rename from docs/model/model-defs-arlas-properties-keycloak-url-anyof-1.md rename to docs/docs/model/model-defs-arlas-properties-keycloak-url-anyof-1.md diff --git a/docs/model/model-defs-arlas-properties-keycloak-url.md b/docs/docs/model/model-defs-arlas-properties-keycloak-url.md similarity index 100% rename from docs/model/model-defs-arlas-properties-keycloak-url.md rename to docs/docs/model/model-defs-arlas-properties-keycloak-url.md diff --git a/docs/model/model-defs-arlas.md b/docs/docs/model/model-defs-arlas.md similarity index 100% rename from docs/model/model-defs-arlas.md rename to docs/docs/model/model-defs-arlas.md diff --git a/docs/model/model-defs-authorizationservice-properties-client-id-anyof-0.md b/docs/docs/model/model-defs-authorizationservice-properties-client-id-anyof-0.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-client-id-anyof-0.md rename to docs/docs/model/model-defs-authorizationservice-properties-client-id-anyof-0.md diff --git a/docs/model/model-defs-authorizationservice-properties-client-id-anyof-1.md b/docs/docs/model/model-defs-authorizationservice-properties-client-id-anyof-1.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-client-id-anyof-1.md rename to docs/docs/model/model-defs-authorizationservice-properties-client-id-anyof-1.md diff --git a/docs/model/model-defs-authorizationservice-properties-client-id.md b/docs/docs/model/model-defs-authorizationservice-properties-client-id.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-client-id.md rename to docs/docs/model/model-defs-authorizationservice-properties-client-id.md diff --git a/docs/model/model-defs-authorizationservice-properties-client-secret-anyof-0.md b/docs/docs/model/model-defs-authorizationservice-properties-client-secret-anyof-0.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-client-secret-anyof-0.md rename to docs/docs/model/model-defs-authorizationservice-properties-client-secret-anyof-0.md diff --git a/docs/model/model-defs-authorizationservice-properties-client-secret-anyof-1.md b/docs/docs/model/model-defs-authorizationservice-properties-client-secret-anyof-1.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-client-secret-anyof-1.md rename to docs/docs/model/model-defs-authorizationservice-properties-client-secret-anyof-1.md diff --git a/docs/model/model-defs-authorizationservice-properties-client-secret.md b/docs/docs/model/model-defs-authorizationservice-properties-client-secret.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-client-secret.md rename to docs/docs/model/model-defs-authorizationservice-properties-client-secret.md diff --git a/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0.md b/docs/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0.md rename to docs/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0.md diff --git a/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1.md b/docs/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1.md rename to docs/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1.md diff --git a/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password.md b/docs/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-grant-type-eg-password.md rename to docs/docs/model/model-defs-authorizationservice-properties-grant-type-eg-password.md diff --git a/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0.md b/docs/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0.md rename to docs/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0.md diff --git a/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1.md b/docs/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1.md rename to docs/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1.md diff --git a/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service.md b/docs/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service.md rename to docs/docs/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service.md diff --git a/docs/model/model-defs-authorizationservice-properties-login.md b/docs/docs/model/model-defs-authorizationservice-properties-login.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-login.md rename to docs/docs/model/model-defs-authorizationservice-properties-login.md diff --git a/docs/model/model-defs-authorizationservice-properties-password.md b/docs/docs/model/model-defs-authorizationservice-properties-password.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-password.md rename to docs/docs/model/model-defs-authorizationservice-properties-password.md diff --git a/docs/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service.md b/docs/docs/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service.md similarity index 100% rename from docs/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service.md rename to docs/docs/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service.md diff --git a/docs/model/model-defs-authorizationservice.md b/docs/docs/model/model-defs-authorizationservice.md similarity index 100% rename from docs/model/model-defs-authorizationservice.md rename to docs/docs/model/model-defs-authorizationservice.md diff --git a/docs/model/model-defs-resource-properties-file-or-http-location.md b/docs/docs/model/model-defs-resource-properties-file-or-http-location.md similarity index 100% rename from docs/model/model-defs-resource-properties-file-or-http-location.md rename to docs/docs/model/model-defs-resource-properties-file-or-http-location.md diff --git a/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties.md b/docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties.md similarity index 100% rename from docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties.md rename to docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties.md diff --git a/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0.md b/docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0.md similarity index 100% rename from docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0.md rename to docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0.md diff --git a/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1.md b/docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1.md similarity index 100% rename from docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1.md rename to docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1.md diff --git a/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests.md b/docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests.md similarity index 100% rename from docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests.md rename to docs/docs/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests.md diff --git a/docs/model/model-defs-resource.md b/docs/docs/model/model-defs-resource.md similarity index 100% rename from docs/model/model-defs-resource.md rename to docs/docs/model/model-defs-resource.md diff --git a/docs/model/model-defs.md b/docs/docs/model/model-defs.md similarity index 100% rename from docs/model/model-defs.md rename to docs/docs/model/model-defs.md diff --git a/docs/model/model-properties-dictionary-of-namearlas-configurations.md b/docs/docs/model/model-properties-dictionary-of-namearlas-configurations.md similarity index 100% rename from docs/model/model-properties-dictionary-of-namearlas-configurations.md rename to docs/docs/model/model-properties-dictionary-of-namearlas-configurations.md diff --git a/docs/model/model-properties-dictionary-of-namemapping-resources.md b/docs/docs/model/model-properties-dictionary-of-namemapping-resources.md similarity index 100% rename from docs/model/model-properties-dictionary-of-namemapping-resources.md rename to docs/docs/model/model-properties-dictionary-of-namemapping-resources.md diff --git a/docs/model/model-properties-dictionary-of-namemodel-resources.md b/docs/docs/model/model-properties-dictionary-of-namemodel-resources.md similarity index 100% rename from docs/model/model-properties-dictionary-of-namemodel-resources.md rename to docs/docs/model/model-properties-dictionary-of-namemodel-resources.md diff --git a/docs/model/model.md b/docs/docs/model/model.md similarity index 100% rename from docs/model/model.md rename to docs/docs/model/model.md diff --git a/docs/model/model.schema.json b/docs/docs/model/model.schema.json similarity index 100% rename from docs/model/model.schema.json rename to docs/docs/model/model.schema.json diff --git a/docs/docs/started.md b/docs/docs/started.md index 4ae106b..eb4b797 100644 --- a/docs/docs/started.md +++ b/docs/docs/started.md @@ -8,10 +8,10 @@ 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 elasicsearch 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 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. 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. 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. ## Running @@ -20,27 +20,28 @@ It can also contain references to index mappings for creating indices. A default > arlas_cli --version 0.2.8 Warning : no configuration file found, we created an empty one for -you (/Users/gaudan/.arlas/cli/configuration.yaml). +you (~/.arlas/cli/configuration.yaml). ``` ## Examples In the following examples, you will see how to: + - generate an elasticsearch mapping based on json objects - add the mapping in elasticsearch - list the elasticsearch indices - add (index) data in the elasticsearch index - get the structure of the mapping -- add a collection in arlas -- list the arlas collection -- get the structure of a arlas collection -- delete a collection from arlas +- add a collection in ARLAS +- list the ARLAS collections +- get the structure of a ARLAS collection +- delete a collection from ARLAS - delete a mapping from elasticsearch - list, create, describe and delete a configuration for `arlas_cli` ... with the `arlas_cli` command line only! -We suppose you hava an elasticsearch and arlas server running. +We suppose you have an elasticsearch and arlas server running. ### Generate the elasticsearch mapping @@ -71,12 +72,14 @@ Note that the three timestamps are not identified as datetimes by `arlas_cli`. T #### Type identification A geometry is identified as such if + - it is a geojson - it is a WKT string -- the fielf name contains `geohash` +- the field name contains `geohash` - it is a string containing two float seperated by a comma A date is identified as such if + - its name is one of `timestamp`, `date`, `start` or `end` and that it can be parsed as a date - its name contains `timestamp`, `date`, `start` or `end` and its values are number within [631152000, 4102444800] or [631152000000, 4102444800000] (year 1990 to 2100) @@ -219,7 +222,7 @@ models: ``` The `arlas` section contains the different deployment configurations. The mapping section lists the mapping template that you can use. - Finaly, the models are the templates for the collections. A [detaild description](docs/model/README.md) of the configuration structure is provided. + Finally, the models are the templates for the collections. A [detailed description](docs/model/README.md) of the configuration structure is provided. ### Create, describe and delete a configuration for `arlas_cli` diff --git a/docs/docs/version.md b/docs/docs/version.md index 2f28773..e20d2c5 100644 --- a/docs/docs/version.md +++ b/docs/docs/version.md @@ -1,2 +1,2 @@ ARLAS Version: -0.2.8 +0.2.9 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index da9fe48..a8618a4 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -27,6 +27,7 @@ theme: accent: 'light-blue' nav: +- arlas_cli version: version.md - About arlas_cli: index.md - Installation: install.md - Getting started: started.md @@ -35,7 +36,7 @@ nav: - Indices: indices.md - Collections: collections.md - Configurations: confs.md -- arlas_cli version: version.md +- Configuration data model: model/model.md plugins: diff --git a/docs/site/404.html b/docs/site/404.html index 84a7e78..8815eed 100644 --- a/docs/site/404.html +++ b/docs/site/404.html @@ -362,6 +362,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/collections/index.html b/docs/site/collections/index.html index d4c803d..f53edd6 100644 --- a/docs/site/collections/index.html +++ b/docs/site/collections/index.html @@ -438,6 +438,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/collections_1/index.html b/docs/site/collections_1/index.html index bebf72a..3d36e74 100644 --- a/docs/site/collections_1/index.html +++ b/docs/site/collections_1/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/collections_2/index.html b/docs/site/collections_2/index.html index 3e792ae..f698d2f 100644 --- a/docs/site/collections_2/index.html +++ b/docs/site/collections_2/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/collections_3/index.html b/docs/site/collections_3/index.html index a2f2339..1ea6047 100644 --- a/docs/site/collections_3/index.html +++ b/docs/site/collections_3/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/collections_4/index.html b/docs/site/collections_4/index.html index 21f7219..416d3d1 100644 --- a/docs/site/collections_4/index.html +++ b/docs/site/collections_4/index.html @@ -364,6 +364,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/confs/index.html b/docs/site/confs/index.html index eba220c..9029df1 100644 --- a/docs/site/confs/index.html +++ b/docs/site/confs/index.html @@ -18,6 +18,8 @@ + + @@ -427,6 +429,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + @@ -492,7 +514,7 @@

    Configurations

    Bug

    -

    If you used the ARLAS Exploration Stack, it is possible that you already have a directory named $HOME/.arlas. This directory has been created by docker as root. The owner of the directory must be changed to the local user (chown ${USER}: $HOME/.arlas).

    +

    If you used the ARLAS Exploration Stack, it is possible that you already have a directory named $HOME/.arlas. This directory has been created by docker as root. The owner of the directory must be changed to the local user (sudo chown ${USER}: $HOME/.arlas).

    List configuration management commands

    arlas_cli confs --help
    Usage: python -m arlas.cli.cli confs [OPTIONS] COMMAND [ARGS]...

    ╭─ Options ──────────────────────────────────────────────────────────╮
    │ --help Show this message and exit. │
    ╰────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ─────────────────────────────────────────────────────────╮
    │ create Add a configuration │
    │ delete Delete a configuration │
    │ describe Describe a configuration │
    │ list List configurations │
    ╰────────────────────────────────────────────────────────────────────╯

    diff --git a/docs/site/confs_1/index.html b/docs/site/confs_1/index.html index 89560b2..3784a67 100644 --- a/docs/site/confs_1/index.html +++ b/docs/site/confs_1/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + @@ -425,7 +445,7 @@

    Confs 1

    Bug

    -

    If you used the ARLAS Exploration Stack, it is possible that you already have a directory named $HOME/.arlas. This directory has been created by docker as root. The owner of the directory must be changed to the local user (chown ${USER}: $HOME/.arlas).

    +

    If you used the ARLAS Exploration Stack, it is possible that you already have a directory named $HOME/.arlas. This directory has been created by docker as root. The owner of the directory must be changed to the local user (sudo chown ${USER}: $HOME/.arlas).

    List configuration management commands

    ```shell

    diff --git a/docs/site/confs_2/index.html b/docs/site/confs_2/index.html index 3567795..01f8855 100644 --- a/docs/site/confs_2/index.html +++ b/docs/site/confs_2/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/confs_3/index.html b/docs/site/confs_3/index.html index 3cae181..3bb6941 100644 --- a/docs/site/confs_3/index.html +++ b/docs/site/confs_3/index.html @@ -364,6 +364,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/help/index.html b/docs/site/help/index.html index 0f8f135..20345ec 100644 --- a/docs/site/help/index.html +++ b/docs/site/help/index.html @@ -420,6 +420,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/index.html b/docs/site/index.html index f830ec1..65e8d72 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -381,6 +381,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/indices/index.html b/docs/site/indices/index.html index b7b0430..6c0d69b 100644 --- a/docs/site/indices/index.html +++ b/docs/site/indices/index.html @@ -447,6 +447,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/indices_1/index.html b/docs/site/indices_1/index.html index ca700bd..6a511ed 100644 --- a/docs/site/indices_1/index.html +++ b/docs/site/indices_1/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/indices_2/index.html b/docs/site/indices_2/index.html index a916099..462f52e 100644 --- a/docs/site/indices_2/index.html +++ b/docs/site/indices_2/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/indices_3/index.html b/docs/site/indices_3/index.html index 4b43115..fdc7dad 100644 --- a/docs/site/indices_3/index.html +++ b/docs/site/indices_3/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/indices_4/index.html b/docs/site/indices_4/index.html index eb69b73..8b8a1a6 100644 --- a/docs/site/indices_4/index.html +++ b/docs/site/indices_4/index.html @@ -369,6 +369,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/indices_5/index.html b/docs/site/indices_5/index.html index 5972a97..92b520e 100644 --- a/docs/site/indices_5/index.html +++ b/docs/site/indices_5/index.html @@ -364,6 +364,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/install/index.html b/docs/site/install/index.html index 05d5f0d..0c889a4 100644 --- a/docs/site/install/index.html +++ b/docs/site/install/index.html @@ -427,6 +427,26 @@ + + + + + + +
  • + + + + + arlas_cli version + + + + +
  • + + + diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml index a7ee91e..5a20ab1 100644 --- a/docs/site/sitemap.xml +++ b/docs/site/sitemap.xml @@ -95,4 +95,9 @@ 2024-02-19 daily + + https://gisaia.github.io/arlas_cli/version/ + 2024-02-19 + daily + \ No newline at end of file diff --git a/docs/site/sitemap.xml.gz b/docs/site/sitemap.xml.gz index 5276d0f95d76421f00f6c6aefa7dd1486d3660aa..9b942e0a2fd4af985ceb7a404208411f7bc173a9 100644 GIT binary patch delta 233 zcmVTIMu8|gk9X_L4})SfYYVe&n+8hHlBwEJe%FeeQ(wl_*+4#vb==10l1Q0}u(Hd!bi j5?5l707)C8&*pLD_+)zSaQ#8%G4JxA8pD3XcgkSVJ^;7 zosE=dBi&~sZ4#G5+B2pvOn!z|BhSE?_S}pb=A?nf_C{&U!I=2S{3v-A%6%5fCJW_5 e;z|q>AZcS1`k?#&H(r + + + + + arlas_cli version + + + + + + + + diff --git a/docs/site/version/index.html b/docs/site/version/index.html new file mode 100644 index 0000000..1d41d6f --- /dev/null +++ b/docs/site/version/index.html @@ -0,0 +1,487 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + arlas_cli version - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    arlas_cli version

    + +

    ARLAS Version: +0.2.9

    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/scripts/release.sh b/scripts/release.sh index 551fc76..895187e 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -25,10 +25,10 @@ git add configuration.yaml # Model export PYTHONPATH=`pwd` -python3 -m arlas.cli.settings > docs/model/model.schema.json -jsonschema2md -d docs/model/ -o docs/model/ +python3 -m arlas.cli.settings > docs/docs/model/model.schema.json +jsonschema2md -d docs/model/ -o docs/docs/model/ rm -r out -git add docs/model +git add docs/docs/model ./scripts/mkdocs.sh mkdocs gh-deploy -f docs/mkdocs.yml