Skip to content

Commit

Permalink
docs: update asset(s) screenshots, fix CLI table layout
Browse files Browse the repository at this point in the history
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
  • Loading branch information
nhoening committed Jul 28, 2022
1 parent 327b6eb commit 7874bd7
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 11 deletions.
14 changes: 9 additions & 5 deletions documentation/cli/commands.rst
Expand Up @@ -14,6 +14,8 @@ You can also get the current overview over the commands you have available by:
.. code-block:: console
flexmeasures --help
flexmeasures [command] --help
This also shows admin commands made available through Flask and installed extensions (such as `Flask-Security <https://flask-security-too.readthedocs.io>`_ and `Flask-Migrate <https://flask-migrate.readthedocs.io>`_),
of which some are referred to in this documentation.
Expand Down Expand Up @@ -45,7 +47,7 @@ of which some are referred to in this documentation.
================================================= =======================================
``flexmeasures show accounts`` List accounts.
``flexmeasures show account`` Show an account, its users and assets.
``flexmeasures show asset-types` List available asset types.
``flexmeasures show asset-types`` List available asset types.
``flexmeasures show asset`` Show an asset and its sensors.
``flexmeasures show roles`` List available account- and user roles.
``flexmeasures show data-sources`` List available data sources.
Expand All @@ -59,18 +61,20 @@ of which some are referred to in this documentation.

================================================= =======================================
``flexmeasures edit attribute`` Edit (or add) an asset attribute or sensor attribute.
``flexmeasures edit resample-data`` Assign a new event resolution to an existing sensor and resample its data accordingly.
``flexmeasures edit resample-data`` | Assign a new event resolution to an existing sensor
| and resample its data accordingly.
================================================= =======================================


``delete`` - Delete data
--------------

================================================= =======================================
``flexmeasures delete structure`` Delete all structural (non time-series) data like assets (types),
roles and users.
``flexmeasures delete structure`` | Delete all structural (non time-series) data,
| like assets (types), roles and users.
``flexmeasures delete account-role`` Delete a tenant account role.
``flexmeasures delete account`` Delete a tenant account & also their users (with assets and power measurements).
``flexmeasures delete account`` | Delete a tenant account & also their users
| (with assets and power measurements).
``flexmeasures delete user`` Delete a user & also their assets and power measurements.
``flexmeasures delete asset`` Delete an asset & also its sensors and data.
``flexmeasures delete sensor`` Delete a sensor and all beliefs about it.
Expand Down
1 change: 1 addition & 0 deletions documentation/index.rst
Expand Up @@ -190,6 +190,7 @@ The platform operator of FlexMeasures can be an Aggregator.
:maxdepth: 1

views/dashboard
views/asset-data
views/admin

.. toctree::
Expand Down
7 changes: 1 addition & 6 deletions documentation/views/admin.rst
Expand Up @@ -4,7 +4,7 @@
Administration
**************

The administrator can edit assets and users here.
The administrator can see assets and users here.

Assets
------
Expand All @@ -15,11 +15,6 @@ Listing all assets:
:align: center
.. :scale: 40%
Viewing & editing one asset:

.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot_asset.png
:align: center
.. :scale: 40%
Users
Expand Down
19 changes: 19 additions & 0 deletions documentation/views/asset-data.rst
@@ -0,0 +1,19 @@
.. _view_asset-data:

**************
Assets & data
**************

The asset page allows to see data from the asset's sensors, and also to edit meta information, like its location:


.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot_asset.png
:align: center
.. :scale: 40%
|
|
.. note:: It is possible to determine which sensors this page should show. For instance, here we include a price sensor from a public asset.
For this, set the `sensors_to_show` attribute with the CLI command ``flexmeasures edit attribute``.

0 comments on commit 7874bd7

Please sign in to comment.