From 93e1c387997aaf3300153ba238f6d4d756895a6f Mon Sep 17 00:00:00 2001 From: RoryPTB <47696929+RoryPTB@users.noreply.github.com> Date: Wed, 11 Sep 2024 08:58:33 +0200 Subject: [PATCH] docs: respond to Maaike's feedback --- docs/source/reference/running/data-pipeline-plugins.rst | 1 + docs/source/user/cap-alerts.rst | 2 ++ docs/source/user/setup.rst | 4 ++-- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/reference/running/data-pipeline-plugins.rst b/docs/source/reference/running/data-pipeline-plugins.rst index 89adeef6..0616c794 100644 --- a/docs/source/reference/running/data-pipeline-plugins.rst +++ b/docs/source/reference/running/data-pipeline-plugins.rst @@ -98,6 +98,7 @@ A typical BUFR4 plugin workflow definition would be defined as follows: notify: true # trigger GeoJSON publishing for API and UI file-pattern: '^.*\.bin$' +.. _cap-message-data-plugin ``wis2box.data.cap_message.CAPMessageData`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/user/cap-alerts.rst b/docs/source/user/cap-alerts.rst index c8d69e46..e5655a1f 100644 --- a/docs/source/user/cap-alerts.rst +++ b/docs/source/user/cap-alerts.rst @@ -36,6 +36,8 @@ When creating a new dataset for CAP alerts, ensure that the **weather/advisories :alt: Select Template :width: 400 +This template will use the 'CAPMessageData' data plugin, see more information on this plugin in the :ref:`cap-message-data-plugin` section of the data pipeline plugins documentation. + Enter the relevant missing information and create the dataset using your processes/wis2box token. .. image:: ../_static/cap/submit_dataset.png diff --git a/docs/source/user/setup.rst b/docs/source/user/setup.rst index 6c35bda3..dc5339f1 100644 --- a/docs/source/user/setup.rst +++ b/docs/source/user/setup.rst @@ -191,8 +191,8 @@ A popup will appear where you can define your "centre-id" and the type of datase The centre-id has to be lowercase and use alphanumeric characters only. The dropdown list shows all currently registered centre-ids on WIS2 as well as any centre-id you have already created in wis2box. -There are 2 pre-defined dataset types for "weather/surface-based-observations/synop" and "weather/surface-based-observations/temp". -We recommend using these pre-defined dataset types to publish your "synop" and "temp" data, respectively. +There are 2 pre-defined dataset types for "weather/surface-based-observations/synop", "weather/surface-based-observations/temp", and "weather/advisories-warnings". +We recommend using these pre-defined dataset types to publish your "synop", "temp", and CAP alert data, respectively. The predefined dataset will predefine the topic and data mappings for you. If you want to create a dataset for a different topic, you can select "other" and define the topic and data mappings yourself.