docs: extend documentation for guess_product_type and other minor upd…

…ates (#756) Co-authored-by: Sylvain Brunato <sylvain.brunato@c-s.fr>
CS-SI · Jul 18, 2023 · 9826723 · 9826723
1 parent 6034cd1
commit 9826723
Show file tree

Hide file tree

Showing 5 changed files with 243 additions and 8 deletions.
diff --git a/docs/api_reference/core.rst b/docs/api_reference/core.rst
@@ -79,6 +79,7 @@ Misc
 .. autosummary::
 
    EODataAccessGateway.group_by_extent
+   EODataAccessGateway.guess_product_type
 
 .. autoclass:: eodag.api.core.EODataAccessGateway
    :members: set_preferred_provider, get_preferred_provider, update_providers_config, list_product_types,

diff --git a/docs/cli_user_guide.rst b/docs/cli_user_guide.rst
@@ -106,6 +106,26 @@ string search sent to the provider. For instance, if you want to add foo=1 and b
                      --cruncher-args FilterOverlap minimum_overlap 10 \
                      --query "foo=1&bar=2"
 
+* If the product type is not known, it can also be guessed by EODAG during the search based on parameters in the search request. The possible parameters are:
+
+        * `instrument` (e.g. MSI)
+        * `platform` (e.g. SENTINEL2)
+        * `platformSerialIdentifier` (e.g. S2A)
+        * `processingLevel` (e.g. L1)
+        * `sensorType` (e.g. OPTICAL)
+        * `keywords` (e.g. SENTINEL2 L1C SAFE), which is case insensitive and ignores `-` or `_` characters
+
+For example, the following search request will first search for a product type for platform SENTINEL2 and processingLevel L1
+(there are several product types matching these criteria, e.g., `S2_MSI_L1C`) and then use this product type to execute the actual search.
+
+.. code-block:: console
+
+        eodag search \
+        --platform SENTINEL2 \
+        --processingLevel L1 \
+        --box 1 43 2 44 \
+        --start 2021-03-01 --end 2021-03-31
+
 * To download the result of a previous call to ``search``:
 
 .. code-block:: console

diff --git a/docs/getting_started_guide/configure.rst b/docs/getting_started_guide/configure.rst
@@ -136,7 +136,7 @@ API: Dynamic configuration
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``eodag`` 's configuration can be altered directly from using Python. See this
-`dedicated page <../notebooks/api_uder_guide/3_configuration.ipynb>`_ in the Python API user guide.
+`dedicated page <../notebooks/api_user_guide/3_configuration.ipynb>`_ in the Python API user guide.
 
 Priority setting
 ^^^^^^^^^^^^^^^^

diff --git a/docs/getting_started_guide/register.rst b/docs/getting_started_guide/register.rst
@@ -59,7 +59,7 @@ to each provider supported by ``eodag``:
 
   * Create an account on `EOS <https://auth.eos.com>`__
 
-  * Get your EOS api key from `here <https://console.eos.com>`__
+  * Get your EOS api key from `here <https://api-connect.eos.com/user-dashboard/statistics>`__
 
   * Create an account on `AWS <https://aws.amazon.com/>`__
 
@@ -102,3 +102,5 @@ to each provider supported by ``eodag``:
     none exists).
 
   * Add these credentials to the user configuration file.
+
+* ``earth_search_cog``: no authentication needed.