Skip to content

Commit

Permalink
docs: respond to Maaike's feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
RoryPTB committed Sep 11, 2024
1 parent b9f8df0 commit 93e1c38
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/source/reference/running/data-pipeline-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Check warning on line 101 in docs/source/reference/running/data-pipeline-plugins.rst

View workflow job for this annotation

GitHub Actions / main

malformed hyperlink target.
``wis2box.data.cap_message.CAPMessageData``

Check warning on line 102 in docs/source/reference/running/data-pipeline-plugins.rst

View workflow job for this annotation

GitHub Actions / main

Explicit markup ends without a blank line; unexpected unindent.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 2 additions & 0 deletions docs/source/user/cap-alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 39 in docs/source/user/cap-alerts.rst

View workflow job for this annotation

GitHub Actions / main

undefined label: cap-message-data-plugin (if the link has no caption the label must precede a section header)

Enter the relevant missing information and create the dataset using your processes/wis2box token.

.. image:: ../_static/cap/submit_dataset.png
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 93e1c38

Please sign in to comment.