Merge pull request #1340 from opendatacube/typo-fix

fix typos
opendatacube · Nov 1, 2022 · 7dff38d · 7dff38d
2 parents f31812e + d8ec496
commit 7dff38d
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 11 deletions.
diff --git 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
@@ -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
@@ -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/...nfig_samples/metadata_type/bare_bone.yaml → ...fig_samples/metadata_types/bare_bone.yaml b/...nfig_samples/metadata_type/bare_bone.yaml → ...fig_samples/metadata_types/bare_bone.yaml
diff --git 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/...installation/data-preperation-scripts.rst → ...installation/data-preparation-scripts.rst b/...installation/data-preperation-scripts.rst → ...installation/data-preparation-scripts.rst
diff --git 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
@@ -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
@@ -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 <https://github.com/opendatacube/datacube-core/blob/develop/datacube/index/default-metadata-types.yaml>`_.
 
 To add or alter metadata types, you can use commands like: ``datacube metadata add <path-to-file>``
 and to update: ``datacube metadata update <path-to-file>``. 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.