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
commit caa2cedcee92b8745bd5a53c66e16695a21bfd04 Author: Dominik Riemer <[email protected]> AuthorDate: Sun May 2 21:54:08 2021 +0200 [STREAMPIPES-197] Add documentation for notification view, add more detailed documentation to dashboard and data explorer view --- documentation/docs/03_use-dashboard.md | 5 +++++ documentation/docs/03_use-data-explorer.md | 4 ++++ documentation/docs/03_use-notifications.md | 20 +++++++++++++++++++- .../01_notifications-overview.png | Bin 0 -> 111204 bytes 4 files changed, 28 insertions(+), 1 deletion(-) diff --git a/documentation/docs/03_use-dashboard.md b/documentation/docs/03_use-dashboard.md index 494bb42..3bc2ed0 100644 --- a/documentation/docs/03_use-dashboard.md +++ b/documentation/docs/03_use-dashboard.md @@ -9,6 +9,11 @@ The entry page of the live dashboard lists all created dashboards as in the scre <img class="docs-image" src="/docs/img/03_use-dashboard/01_dashboard-overview.png" alt="StreamPipes Dashboard Overview"> +## Visualizing Data Streams + +To visualize data streams in the live dashboard, a pipeline must be created that makes use of the so-called **Dashboard Sink**. +Any data stream or data processor can serve as an input of the dashboard sink. Switch to the pipeline editor, create a pipeline and configure the dashboard sink. The visualization name is used to identify the sink in case multiple dashboard sinks are used within a single pipeline. + ## Managing Dashboards Multiple dashboards can be created, e.g., to organize different assets in a single dashboard view. diff --git a/documentation/docs/03_use-data-explorer.md b/documentation/docs/03_use-data-explorer.md index dfed4c1..1ff9053 100644 --- a/documentation/docs/03_use-data-explorer.md +++ b/documentation/docs/03_use-data-explorer.md @@ -12,3 +12,7 @@ It provides a canvas where various visualizations from multiple pipelines can be The data explorer is currently available as an early beta version and features are still subject to change. A more detailed documentation will be available once the data explorer is available in a stable version. +## Using the data explorer + +In the data explorer, any pipeline that uses the so-called **Data Lake** sink can be explored in the data explorer. Switch to the pipeline editor and add the data lake sink to a data processor or stream. +The sink requires an index name as a configuration parameter, which is used as an identifier in the data explorer. diff --git a/documentation/docs/03_use-notifications.md b/documentation/docs/03_use-notifications.md index 6f144b3..245a0bb 100644 --- a/documentation/docs/03_use-notifications.md +++ b/documentation/docs/03_use-notifications.md @@ -4,4 +4,22 @@ title: Notifications sidebar_label: Notifications --- -tbd \ No newline at end of file +The notification module can be used to create internal notifications. + +<img class="docs-image" src="/docs/img/03_use-notifications/01_notifications-overview.png" alt="StreamPipes Notifications"> + +## Using notifications + +Any pipeline that includes the data sink **Notification** can trigger notifications that appear in the notification view. To configure a new notification, switch to the pipeline editor and append the notification sink to a data processor or data stream. +The sink requires a title and message as configuration parameters. + +### Placeholders + +The notification message can include placeholders for fields which are replaced with the actual value at runtime. + +## Managing notifications + +The notification view is split into two parts. The left sides lists all pipelines which include a notification sink. By selecting a pipeline, available notifications will be shown in the right panel. +By scrolling up, older notifications become visible. Notifications that have appeared in the detail view will be automatically marked as read, so that only new, unread notifications will appear in the left toolbar. + + diff --git a/documentation/website/static/img/03_use-notifications/01_notifications-overview.png b/documentation/website/static/img/03_use-notifications/01_notifications-overview.png new file mode 100644 index 0000000..688a987 Binary files /dev/null and b/documentation/website/static/img/03_use-notifications/01_notifications-overview.png differ
