Skip to content

Commit

Permalink
docs: respond to Tom's comments
Browse files Browse the repository at this point in the history
  • Loading branch information
RoryPTB committed Sep 11, 2024
1 parent 7d5916d commit 6072028
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ format. [Jupyter](https://jupyter.org) notebooks are also used for in-depth cod

## Setup
To update the documentation, ensure that Sphinx, nbsphinx and Jupyter are installed on your system (hint:
run `pip install -r requirements.txt` to install the dependencies). From here, `make html` (or `./make html`) will
run `pip install -r requirements.txt` to install the dependencies). From here, `make html` (or `./make.bat html` on Windows) will
build the documentation, which you can serve using any standard web server.

## Jupyter
Expand Down
8 changes: 4 additions & 4 deletions docs/source/user/cap-alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Process Outline
---------------
For automated publishing of CAP alerts created by the CAP Composer to a wis2box, we will need to perform the following steps:

1. *Dataset Creation:* Configure the dataset in the wis2box to store the CAP alerts.
1. *Dataset Creation:* Configure the dataset in wis2box to store the CAP alerts.
2. *MQTT Configuration:* Configure your wis2box broker details in the CAP Composer.

Dataset Creation
----------------
Firstly, there must be a dataset in the wis2box for the CAP alerts to be stored. To create a dataset, simply navigate to the 'Dataset Editor' page in the wis2box-webapp, available on your host at `http://<your-public-ip>/wis2box-webapp`.
Firstly, there must be a dataset in wis2box for the CAP alerts to be stored. To create a dataset, simply navigate to the 'Dataset Editor' page in wis2box-webapp, available on your host at `http://<your-public-ip>/wis2box-webapp`.

.. note::
For more information on how to create a dataset, please see the :ref:`adding-datasets` section of the wis2box setup guide.
Expand Down Expand Up @@ -115,9 +115,9 @@ Additional diagnostic information can be found by clicking the *Inspect* button.

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.
We can verify that the alert has been successfully published to wis2box by monitoring the dataset in wis2box-webapp.

Navigate to the 'Monitoring' page in the wis2box-webapp, and select the dataset that you created in the previous steps.
Navigate to the 'Monitoring' page in wis2box-webapp, and select the dataset that you created in the previous steps.

.. note::
If you do not see the dataset, ensure that the datetime range selected includes the time of the alert publication.
Expand Down

0 comments on commit 6072028

Please sign in to comment.