update screenshot

wmo-im · Jan 10, 2025 · fc24ed6 · fc24ed6
1 parent bbafee3
commit fc24ed6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/docs/source/_static/wis2box-webapp-dataset_editor_local_id.png b/docs/source/_static/wis2box-webapp-dataset_editor_local_id.png
diff --git a/docs/source/user/data-ingest.rst b/docs/source/user/data-ingest.rst
@@ -19,7 +19,7 @@ The wis2box provides 3 types of built-in plugins to publish data in BUFR format:
 
 * `bufr2bufr` : the input is received in BUFR format and split by subset, where each subset is published as a separate bufr message
 * `synop2bufr` : the input is received in `FM-12 SYNOP format <https://library.wmo.int/idviewer/35713/33>`_ and converted to BUFR format. The year and month are extracted from the file pattern
-* `csv2bufr` : the input is received in CSV format and converted to BUFR format, a mapping template is required to convert the CSV columns to BUFR encoded values. See :ref:`csv2bufr-plugin` for information on how to configure the csv2bufr plugin.
+* `csv2bufr` : the input is received in CSV format and converted to BUFR format, a mapping template is used to convert the CSV columns to BUFR encoded values. Custom mapping templates need to be placed in the ``$WIS2BOX_HOST_DATADIR/mappings`` directory. See the repository at `csv2bufr-templates`_ for examples of mapping templates
 
 To publish data for other data formats you can use the 'Universal' plugin, which will pass through the data without any conversion.
 Please note that you will need to ensure that the date timestamp can be extracted from the file pattern when using this plugin.

diff --git a/docs/source/user/setup.rst b/docs/source/user/setup.rst
@@ -199,6 +199,16 @@ If you want to create a dataset for a different topic, you can select "other" an
 
 Please select "Continue to form" to start defining your dataset.
 
+When defining your dataset, you will need to specify a Local ID, which serves as a short and unique identifier for the dataset within your organization. The Local ID is used to generate the WCMP2 identifier for your metadata record.
+
+.. image:: ../_static/wis2box-webapp-dataset_editor_local_id.png
+  :width: 800
+  :alt: wis2box webapp dataset editor page, localID
+
+.. note::
+
+   If you do not provide a Local ID a randomly generated ID will be assigned. It is strongly suggested to define your own human-readable ID instead. Once the dataset is created, the Local ID cannot be changed. To use a different Local ID, you will need to delete and recreate the dataset.
+
 Make sure to provide a "description" for your dataset, review and add keywords and choose an appropriate bounding box.
 You will also need to provide some contact information for the dataset.