Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maaikelimper committed Sep 21, 2023
1 parent bf7f721 commit 6440473
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
7 changes: 4 additions & 3 deletions docs/source/community/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ ERROR - Failed to publish, wsi: ..., tsi: XXXXX
-----------------------------------------------

Data arrived for a station that is not present in the station metadata cache.
To add missing stations, update the file ``metadata/station/station_list.csv`` in the wis2box data directory (see :ref:`setup`).
To add missing stations, use the station-editor in wis2box-webapp (from wis2box-1.0b5) or update the file ``metadata/station/station_list.csv`` in the wis2box data directory (see :ref:`setup`).

Error: no such container: wis2box-management
--------------------------------------------
Expand All @@ -101,6 +101,7 @@ Please check all services are Running using the following command:
Possible issues are:

- The host ran out of disk-space, check the output of 'df -h' and ensure there is sufficient space available
- The directory defined by WIS2BOX_HOST_DATADIR does not contain the file 'data-mappings.yml' or the file is invalid
- The directory defined by WIS2BOX_HOST_DATADIR does not contain the file 'metastation/station/station_list.csv' or the file is invalid
- WIS2BOX_STORAGE_PASSWORD is too short, minio will fail to start if you specify a WIS2BOX_STORAGE_PASSWORD of less than 8 characters
Expand All @@ -122,5 +123,5 @@ And repeat the commands for adding your dataset and publishing your metadata, to
.. code-block:: bash
python3 wis2box-ctl.py login
wis2box data add-collection ${WIS2BOX_DATADIR}/surface-weather-observations.yml
wis2box metadata discovery publish ${WIS2BOX_DATADIR}/surface-weather-observations.yml
wis2box data add-collection /data/wis2box/metadata/discovery/metadata-synop.yml
wis2box metadata discovery publish /data/wis2box/metadata/discovery/metadata-synop.yml
10 changes: 8 additions & 2 deletions docs/source/reference/auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,19 @@ To add a token to the execution of a wis2box process, use the following command:

.. code-block:: bash
wis2box auth add-token --path processes/wis2box myexecutiontoken
wis2box auth add-token --path processes/wis2box
This will generate a random token that can be used to execute ``wis2box-synop2bufr`` and ``wis2box-csv2bufr``.
Be sure to record the token now, there is no way to retrieve it once it is lost.

To add a token to PUT/POST/DELETE requests to the stations collection, use the following command:

.. code-block:: bash
wis2box auth add-token --path collections/stations mystationupdatetoken
wis2box auth add-token --path collections/stations
This will generate a random token that can be use to update the stations collection.
Be sure to record the token now, there is no way to retrieve it once it is lost.

Adding Access Control on topics
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ The wis2box-webapp can be accessed by visiting the URL you specified during the

Please note only data for stations that have been added to the wis2box will be ingested and result in WIS2 notifications being published.

You can also bulk-insert a set of stations from a CSV file, by specifying the stations in metadata/stations/station_list.csv in your wis2box-host-directory and running the following command:
You can also bulk-insert a set of stations from a CSV file, by defining the stations in metadata/stations/station_list.csv in your wis2box-host-directory and running the following command:

.. code-block:: bash
Expand Down

0 comments on commit 6440473

Please sign in to comment.