This is an automated email from the ASF dual-hosted git repository.
riemer pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampipes-website.git
The following commit(s) were added to refs/heads/dev by this push:
new be6f66b [STREAMPIPES-197] Add documentation for live dashboard
be6f66b is described below
commit be6f66b11ddf1a25e496da165a93dd778a24ce79
Author: Dominik Riemer <[email protected]>
AuthorDate: Sat May 1 14:01:38 2021 +0200
[STREAMPIPES-197] Add documentation for live dashboard
---
documentation/docs/03_use-dashboard.md | 56 ++++++++++++++++++++-
.../img/03_use-dashboard/01_dashboard-overview.png | Bin 0 -> 79029 bytes
.../static/img/03_use-dashboard/02_add-widget.png | Bin 0 -> 146471 bytes
.../img/03_use-dashboard/03_configure-widget.png | Bin 0 -> 110224 bytes
.../img/03_use-dashboard/04_live-dashboard.png | Bin 0 -> 123586 bytes
5 files changed, 55 insertions(+), 1 deletion(-)
diff --git a/documentation/docs/03_use-dashboard.md
b/documentation/docs/03_use-dashboard.md
index 3e6c5f3..494bb42 100644
--- a/documentation/docs/03_use-dashboard.md
+++ b/documentation/docs/03_use-dashboard.md
@@ -4,4 +4,58 @@ title: Live Dashboard
sidebar_label: Live Dashboard
---
-tbd
\ No newline at end of file
+The live dashboard can be used to visualize live data of data streams using a
set of visualizations
+The entry page of the live dashboard lists all created dashboards as in the
screenshot below:
+
+<img class="docs-image"
src="/docs/img/03_use-dashboard/01_dashboard-overview.png" alt="StreamPipes
Dashboard Overview">
+
+## Managing Dashboards
+Multiple dashboards can be created, e.g., to organize different assets in a
single dashboard view.
+
+A new dashboard can be created by clicking the _New Dashboard_ button, which
opens a dialog that requires basic dashboard settings such as the title and
description of the new dashboard.
+Once created, the dashboard will be shown in the overview. Here, the following
dashboard actions are available:
+
+* **Show** opens the dashboard.
+* **Window** opens the dashboard in a new window with reduced controls, e.g.,
without the StreamPipes navigation and toolbar. This is a useful view for
standalone displays that should visualize key parameters.
+* **Settings** allows to modify the basic dashboard settings.
+* **Edit** opens the dashboard in edit mode, where widgets can be added to the
dashboard.
++ **Delete** deletes the selected dashboard.
+
+## Creating Visualizations
+
+Visualizations can be added to each dashboard in form of widgets. To add new
visualizations, switch to the dashboard in _Edit_ mode.
+In edit mode, a button appears that allows to add a new visualization.
+
+Adding a new visualization is supported by a wizard consisting of three steps:
+
+<img class="docs-image" src="/docs/img/03_use-dashboard/02_add-widget.png"
alt="StreamPipes Dashboard Pipeline Selection">
+
+* **Select pipeline** is the first step where a pipeline is selected on which
the visualization is based. In this view, all pipelines are listed that have at
least one **Dashboard Sink**. In case a pipeline contains multiple dashboard
sinks, the visualization name is listed below the pipeline name which eases
discovering of the proper visualization.
+* **Select widget** is the next step where the visualization widget must be
selected. StreamPipes automatically filters this list based on input
requirements of widgets. For instance, image visualizations are only visible if
the input data stream provides an image object.
+* **Configure widget** provides widget-specific settings to configure the
visualization. In most cases, colors and titles of widgets can be modified.
Additionally, chart-specific settings such as axis value ranges can be
configured.
+
+<img class="docs-image"
src="/docs/img/03_use-dashboard/03_configure-widget.png" alt="StreamPipes
Dashboard Widget Configuration">
+
+By clicking _Create_, the new widget is placed on the canvas. Size and
positioning of visualizations can be flexibly changed based on the provided
grid. To change the widget configuration, the _Settings_ button of each widget
can be clicked to re-open the configuration dialog.
+
+Once created, the dashboard provides a live view of all visualizations:
+
+<img class="docs-image" src="/docs/img/03_use-dashboard/04_live-dashboard.png"
alt="StreamPipes Live Dashboard">
+
+
+Before the dashboard is closed, make sure to click the _Save_ button to
persist the updated dashboard. Changes can be discarded by clicking the
_Discard_ button.
+
+
+## Available widgets
+
+The following visualizations are available in the latest release:
+
+* Area Chart
+* Gauge
+* HTML page (renders HTML markup)
+* Image
+* Line Chart
+* Raw (displays the raw JSON input for debugging purposes)
+* Single Value (displays a single measurement)
+* Table
+* Traffic Light
diff --git
a/documentation/website/static/img/03_use-dashboard/01_dashboard-overview.png
b/documentation/website/static/img/03_use-dashboard/01_dashboard-overview.png
new file mode 100644
index 0000000..0a1e90e
Binary files /dev/null and
b/documentation/website/static/img/03_use-dashboard/01_dashboard-overview.png
differ
diff --git
a/documentation/website/static/img/03_use-dashboard/02_add-widget.png
b/documentation/website/static/img/03_use-dashboard/02_add-widget.png
new file mode 100644
index 0000000..72a0678
Binary files /dev/null and
b/documentation/website/static/img/03_use-dashboard/02_add-widget.png differ
diff --git
a/documentation/website/static/img/03_use-dashboard/03_configure-widget.png
b/documentation/website/static/img/03_use-dashboard/03_configure-widget.png
new file mode 100644
index 0000000..8a40f8a
Binary files /dev/null and
b/documentation/website/static/img/03_use-dashboard/03_configure-widget.png
differ
diff --git
a/documentation/website/static/img/03_use-dashboard/04_live-dashboard.png
b/documentation/website/static/img/03_use-dashboard/04_live-dashboard.png
new file mode 100644
index 0000000..d7a8db6
Binary files /dev/null and
b/documentation/website/static/img/03_use-dashboard/04_live-dashboard.png differ
