From d8ec496429c8ff4d98e0b1e4a6e4cbfa85160e29 Mon Sep 17 00:00:00 2001 From: "pin.jin@ga.gov.au" Date: Tue, 1 Nov 2022 21:41:28 +0000 Subject: [PATCH] fix typos --- README.rst | 6 +++--- docs/about-core-concepts/products.rst | 2 +- docs/about/whats_new.rst | 1 + .../bare_bone.yaml | 0 docs/installation/cli.rst | 8 +++++--- ...on-scripts.rst => data-preparation-scripts.rst} | 0 docs/installation/database/setup.rst | 2 +- docs/installation/index.rst | 2 +- docs/installation/metadata-types.rst | 14 ++++++++++++-- 9 files changed, 24 insertions(+), 11 deletions(-) rename docs/config_samples/{metadata_type => metadata_types}/bare_bone.yaml (100%) rename docs/installation/{data-preperation-scripts.rst => data-preparation-scripts.rst} (100%) diff --git a/README.rst b/README.rst index 01cac05252..8d64b0d940 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,15 @@ Open Data Cube Core =================== -.. image::https://github.com/opendatacube/datacube-core/workflows/build/badge.svg +.. image:: https://github.com/opendatacube/datacube-core/workflows/build/badge.svg :alt: Build Status :target: https://github.com/opendatacube/datacube-core/actions -.. image::https://codecov.io/gh/opendatacube/datacube-core/branch/develop/graph/badge.svg +.. image:: https://codecov.io/gh/opendatacube/datacube-core/branch/develop/graph/badge.svg :alt: Coverage Status :target: https://codecov.io/gh/opendatacube/datacube-core -.. image::https://readthedocs.org/projects/datacube-core/badge/?version=latest +.. image:: https://readthedocs.org/projects/datacube-core/badge/?version=latest :alt: Documentation Status :target: http://datacube-core.readthedocs.org/en/latest/ diff --git a/docs/about-core-concepts/products.rst b/docs/about-core-concepts/products.rst index 8d4eefa4ee..70ac47cd76 100644 --- a/docs/about-core-concepts/products.rst +++ b/docs/about-core-concepts/products.rst @@ -187,4 +187,4 @@ Example 3D product definition for GEDI L2B cover_z: .. note:: - `extra_dimensions` is defined the yaml + `extra_dimensions` is defined in the yaml diff --git a/docs/about/whats_new.rst b/docs/about/whats_new.rst index f68f42df86..c75132adfe 100644 --- a/docs/about/whats_new.rst +++ b/docs/about/whats_new.rst @@ -16,6 +16,7 @@ v1.8.next - Follow PEP561_ to make type hints available to other packages (:issue:`1330`) - Add what's new page link to menu and general doc fixes (:pull:`1335`) - Add `search_fields` to required for metadata type schema and update doc (:pull:`1339`) +- Fix typo and update metadata documentation (:pull:`1340`) .. _PEP561: https://peps.python.org/pep-0561/ diff --git a/docs/config_samples/metadata_type/bare_bone.yaml b/docs/config_samples/metadata_types/bare_bone.yaml similarity index 100% rename from docs/config_samples/metadata_type/bare_bone.yaml rename to docs/config_samples/metadata_types/bare_bone.yaml diff --git a/docs/installation/cli.rst b/docs/installation/cli.rst index 186554443a..8368a75788 100644 --- a/docs/installation/cli.rst +++ b/docs/installation/cli.rst @@ -5,16 +5,18 @@ The Open Data Cube offers a CLI for common administrative tasks related to the O .. click:: datacube.scripts.cli_app:cli - :prog: datacube :show-nested: .. click:: datacube.scripts.search_tool:cli - :prog: datacube-search :show-nested: .. click:: datacube.execution.worker:main - :prog: datacube-worker :show-nested: + + +.. note:: + + To check all available CLI go to https://github.com/opendatacube/datacube-core/tree/develop/datacube/scripts diff --git a/docs/installation/data-preperation-scripts.rst b/docs/installation/data-preparation-scripts.rst similarity index 100% rename from docs/installation/data-preperation-scripts.rst rename to docs/installation/data-preparation-scripts.rst diff --git a/docs/installation/database/setup.rst b/docs/installation/database/setup.rst index 2ddab9635a..d6c596284a 100644 --- a/docs/installation/database/setup.rst +++ b/docs/installation/database/setup.rst @@ -71,7 +71,7 @@ Datacube looks for a configuration file in ~/.datacube.conf or in the location s Uncomment and fill in lines as required. -Alternately, you can configure the ODC connection to Postgres using environment variables: +Alternately, you can configure the ODC connection to Postgres using environment variables:: DB_HOSTNAME DB_USERNAME diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 61c5b4ac72..f2422569ce 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -53,5 +53,5 @@ This section contains information on setting up and managing the Open Data Cube. .. toctree:: :caption: Legacy Approaches - data-preperation-scripts + data-preparation-scripts ingesting-data/index diff --git a/docs/installation/metadata-types.rst b/docs/installation/metadata-types.rst index b05bdf18bb..0f206016bf 100644 --- a/docs/installation/metadata-types.rst +++ b/docs/installation/metadata-types.rst @@ -3,13 +3,23 @@ Metadata Types A Metadata Type defines which fields should be searchable in your product or dataset metadata. -Two metadata types are added by default called ``eo`` and ``eo3``. +Three metadata types are added by default called ``eo``, ``telemetry`` and ``eo3``. You would create a new metadata type if you want custom fields to be searchable for your products, or if you want to structure your metadata documents differently. -You can see the default metadata type in the repository at ``datacube/index/default-metadata-types.yaml``. +You can see the default metadata type in the repository at `datacube/index/default-metadata-types.yaml `_. To add or alter metadata types, you can use commands like: ``datacube metadata add `` and to update: ``datacube metadata update ``. Using ``--allow-unsafe`` will allow you to update metadata types where the changes may have unexpected consequences. + + +.. literalinclude:: ../config_samples/metadata_types/bare_bone.yaml + :language: yaml + +.. note:: + + Metadata type yaml file must contain name, description and dataset keys. + + Dataset key must contain id, sources, creation_dt, label and search_fields keys.