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 a721b2a [STREAMPIPES-197] Add documentation for pipeline overview
a721b2a is described below
commit a721b2a856a32357339d409c1af5a9849e331d55
Author: Dominik Riemer <[email protected]>
AuthorDate: Sat May 1 14:26:54 2021 +0200
[STREAMPIPES-197] Add documentation for pipeline overview
---
documentation/docs/03_use-managing-pipelines.md | 47 ++++++++++++++++++++-
.../01_pipeline-overview.png | Bin 0 -> 91739 bytes
.../02_pipeline-start-dialog.png | Bin 0 -> 136314 bytes
.../03_pipeline-details.png | Bin 0 -> 180477 bytes
.../04_pipeline-quick-edit.png | Bin 0 -> 157995 bytes
5 files changed, 46 insertions(+), 1 deletion(-)
diff --git a/documentation/docs/03_use-managing-pipelines.md
b/documentation/docs/03_use-managing-pipelines.md
index 2628f35..3406e6a 100644
--- a/documentation/docs/03_use-managing-pipelines.md
+++ b/documentation/docs/03_use-managing-pipelines.md
@@ -4,4 +4,49 @@ title: Managing Pipelines
sidebar_label: Managing Pipelines
---
-tbd
+The pipeline view lists all created pipelines and provides several views and
actions to manage the lifecycle of pipelines.
+
+In the entry screen, an overview of all created pipelines is shown:
+
+<img class="docs-image"
src="/docs/img/03_use-managing-pipelines/01_pipeline-overview.png"
alt="StreamPipes Pipeline Overview">
+
+## Pipeline Actions
+Within the pipeline overview, for each pipeline several actions are available:
+* **Start/Stop pipeline** Starts or stops the selected pipeline. Once clicked,
StreamPipes will trigger the selected action for all pipeline elements and open
a success or error dialog as illustrated below.
+* **Show details** opens the pipeline detail view (see below).
+* **Modify pipeline** opens the pipeline in the pipeline editor, where the
pipeline can be modified. Note that this button is only visible if the pipeline
is not running.
+* **Delete pipeline** opens a confirm dialog, which subsequently deletes the
selected pipeline.
+
+The screenshot below shows the status of a pipeline after it has been
successfully started. By clicking the _Show details_ button, more information
on the status of each corresponding pipeline element microservice becomes
available. In case of failures, the failure reason will be shown for each
pipeline element that has failed to start.
+
+<img class="docs-image"
src="/docs/img/03_use-managing-pipelines/02_pipeline-start-dialog.png"
alt="StreamPipes Pipeline Start Dialog">
+
+## Organizing Pipelines into Categories
+Pipelines can be organized into categories, which is a useful feature in case
a larger amount of pipelines is created.
+All categories will be shown as separate tabs in the pipeline overview. The
same pipeline can be assigned to multiple categories.
+
+To add a new category or to add a new pipeline to an existing category, click
the _Manage Categories_ button and configured the category and assigned
pipelines in the dialog.
+
+## Pipeline Details
+The pipeline details view can be opened by clicking the _Show details_ button
in the pipeline overview panel.
+
+<img class="docs-image"
src="/docs/img/03_use-managing-pipelines/03_pipeline-details.png"
alt="StreamPipes Pipeline Details">
+
+### Overview
+The overview section displays the graphical structure of the pipeline and
provides some statistics about recent pipeline actions. Additionally, pipelines
can be directly started, stopped, modified and deletes within this view.
+
+### Monitoring
+Monitoring features will become available in version 0.68.0.
+
+### Errors
+Monitoring of failures and logs will become available in version 0.69.0.
+
+### QuickEdit
+The quick edit feature (only available for pipelines that are not running) is
a quick and convenient way to modify some pipeline element configurations
without opening the pipeline in the pipeline editor.
+To use the quick edit feature, switch to the _QuickEdit_ tab, which will
display the selected pipeline.
+
+By clicking a pipeline element from the preview canvas, available
configuration options of the selected pipeline element can be modified. Note
that only modifications that do not affect the pipeline structure (e.g.,
different output streams) can be changed.
+
+<img class="docs-image"
src="/docs/img/03_use-managing-pipelines/04_pipeline-quick-edit.png"
alt="StreamPipes Pipeline Quick Edit">
+
+After a configuration value was changed, make sure to click the _Update
Pipeline_ button to save the changes.
diff --git
a/documentation/website/static/img/03_use-managing-pipelines/01_pipeline-overview.png
b/documentation/website/static/img/03_use-managing-pipelines/01_pipeline-overview.png
new file mode 100644
index 0000000..4579e1a
Binary files /dev/null and
b/documentation/website/static/img/03_use-managing-pipelines/01_pipeline-overview.png
differ
diff --git
a/documentation/website/static/img/03_use-managing-pipelines/02_pipeline-start-dialog.png
b/documentation/website/static/img/03_use-managing-pipelines/02_pipeline-start-dialog.png
new file mode 100644
index 0000000..b6814ca
Binary files /dev/null and
b/documentation/website/static/img/03_use-managing-pipelines/02_pipeline-start-dialog.png
differ
diff --git
a/documentation/website/static/img/03_use-managing-pipelines/03_pipeline-details.png
b/documentation/website/static/img/03_use-managing-pipelines/03_pipeline-details.png
new file mode 100644
index 0000000..d0b5e8e
Binary files /dev/null and
b/documentation/website/static/img/03_use-managing-pipelines/03_pipeline-details.png
differ
diff --git
a/documentation/website/static/img/03_use-managing-pipelines/04_pipeline-quick-edit.png
b/documentation/website/static/img/03_use-managing-pipelines/04_pipeline-quick-edit.png
new file mode 100644
index 0000000..9b4e842
Binary files /dev/null and
b/documentation/website/static/img/03_use-managing-pipelines/04_pipeline-quick-edit.png
differ
