From 0f724833febc6256ac7f155adb5443845a9298bd Mon Sep 17 00:00:00 2001 From: RoryPTB <47696929+RoryPTB@users.noreply.github.com> Date: Wed, 11 Sep 2024 09:00:57 +0200 Subject: [PATCH 1/4] fix: correct cap data plugin reference --- docs/source/reference/running/data-pipeline-plugins.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/reference/running/data-pipeline-plugins.rst b/docs/source/reference/running/data-pipeline-plugins.rst index 0616c794..00f2e849 100644 --- a/docs/source/reference/running/data-pipeline-plugins.rst +++ b/docs/source/reference/running/data-pipeline-plugins.rst @@ -98,7 +98,8 @@ 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 +.. _cap-message-data-plugin: + ``wis2box.data.cap_message.CAPMessageData`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 1756f4d527cd11eceb5cbe2b6e386fa57fc48d72 Mon Sep 17 00:00:00 2001 From: RoryPTB <47696929+RoryPTB@users.noreply.github.com> Date: Wed, 11 Sep 2024 09:04:00 +0200 Subject: [PATCH 2/4] docs: improve wording --- docs/source/user/setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/user/setup.rst b/docs/source/user/setup.rst index dc5339f1..b3ad9ba5 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", "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. +There are multiple pre-defined datasets, such as "weather/surface-based-observations/synop", "weather/surface-based-observations/temp", and "weather/advisories-warnings". +We recommend using these particular 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. From 33d2652d61d2c3ffa8270c6d8ccc56740d897ae6 Mon Sep 17 00:00:00 2001 From: RoryPTB <47696929+RoryPTB@users.noreply.github.com> Date: Wed, 11 Sep 2024 09:05:17 +0200 Subject: [PATCH 3/4] docs: address indentation warning --- docs/source/user/setup.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/user/setup.rst b/docs/source/user/setup.rst index b3ad9ba5..31f49add 100644 --- a/docs/source/user/setup.rst +++ b/docs/source/user/setup.rst @@ -163,6 +163,7 @@ The values of ``WIS2BOX_WEBAPP_USERNAME`` and ``WIS2BOX_WEBAPP_PASSWORD`` can be .. _adding-datasets: + Adding datasets --------------- From 4ef696ae948ac7d592c58773e1dc0104c9c887ed Mon Sep 17 00:00:00 2001 From: RoryPTB <47696929+RoryPTB@users.noreply.github.com> Date: Wed, 11 Sep 2024 09:07:38 +0200 Subject: [PATCH 4/4] docs: consistent wording --- docs/source/user/setup.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/user/setup.rst b/docs/source/user/setup.rst index 31f49add..1fa41cef 100644 --- a/docs/source/user/setup.rst +++ b/docs/source/user/setup.rst @@ -192,8 +192,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 multiple pre-defined datasets, such as "weather/surface-based-observations/synop", "weather/surface-based-observations/temp", and "weather/advisories-warnings". -We recommend using these particular pre-defined dataset types to publish your "synop", "temp", and CAP alert data, respectively. +There are multiple predefined datasets, such as "weather/surface-based-observations/synop", "weather/surface-based-observations/temp", and "weather/advisories-warnings". +We recommend using these particular predefined 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. @@ -209,7 +209,7 @@ Before publishing the new dataset make to click "Validate form" to check if all :alt: wis2box webapp dataset editor page, validate form Each dataset is associated with data-mappings plugins that transform the data from the input source format before the data is published. -If you are using the pre-defined dataset types for "synop" and "temp" data, the data mappings plugins will be pre-defined for you. +If you are using the predefined dataset types for "synop", "temp", or CAP alert data, the data mappings plugins will be predefined for you. Otherwise, you will need to define the data mappings plugins for your dataset. Finally, click "submit" to publish the dataset: