Skip to content

Commit

Permalink
docs: add section on viewing published alerts
Browse files Browse the repository at this point in the history
  • Loading branch information
RoryPTB committed Sep 10, 2024
1 parent f0fd95f commit b9f8df0
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
Binary file added docs/source/_static/cap/alert_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/cap/download_view_alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 14 additions & 4 deletions docs/source/user/cap-alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ You can view the status of the published alert in the 'CAP Alerts', then 'MQTT B

Additional diagnostic information can be found by clicking the *Inspect* button.

Verifying Receipt of a Published Alert
--------------------------------------
Verifying Receipt of a Published Alert and Viewing the Alert
------------------------------------------------------------
We can verify that the alert has been successfully published to the wis2box by monitoring the dataset in the wis2box-webapp.

Navigate to the 'Monitoring' page in the wis2box-webapp, and select the dataset that you created in the previous steps.
Expand All @@ -124,6 +124,16 @@ Navigate to the 'Monitoring' page in the wis2box-webapp, and select the dataset
:alt: Monitoring Dashboard
:width: 800

Provided the publication was successful, you will see a bar in the 'Notifications' section. If you scroll down to the 'Published Data' section, the signed and verified CAP alert should appear in the table to download and inspect.
Provided the publication was successful, you will see a bar in the 'Notifications' section. If you scroll down to the 'Published Data' section, the signed and verified CAP alert should appear in the table to download and view.

TO DO: Add image here that shows the 'Inspect Alert' button.
.. image:: ../_static/cap/download_view_alert.png
:alt: Published Data
:width: 800

On clicking the *View Alert* button, you should see a visualization of the CAP alert you created earlier.

.. image:: ../_static/cap/alert_preview.png
:alt: View Alert
:width: 800

Congratulations! You have successfully published a CAP alert to a wis2box using the CAP Composer.

0 comments on commit b9f8df0

Please sign in to comment.