You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ri...@apache.org on 2023/01/16 15:49:24 UTC
[streampipes-website] branch dev updated: Update screenshots in documentation
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/streampipes-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 56a2e17f Update screenshots in documentation
new b30ea785 Merge branch 'dev' of github.com:apache/streampipes-website into dev
56a2e17f is described below
commit 56a2e17fc77d2a021f705f2a57195b957a42c440
Author: Dominik Riemer <do...@gmail.com>
AuthorDate: Mon Jan 16 16:48:55 2023 +0100
Update screenshots in documentation
---
documentation/docs/01_try-overview.md | 4 ++--
documentation/docs/03_use-connect.md | 8 ++++++--
documentation/docs/03_use-pipeline-editor.md | 2 --
documentation/website/i18n/en.json | 4 ++++
documentation/website/static/css/custom.css | 4 ++++
.../static/img/01_try-installation/03_login.png | Bin 77382 -> 73084 bytes
.../static/img/01_try-installation/04_home.png | Bin 165926 -> 170913 bytes
.../01_try-overview/01_streampipes-overview.png | Bin 624766 -> 661478 bytes
.../img/03_use-connect/01_connect-overview.png | Bin 169692 -> 165317 bytes
.../img/03_use-connect/02_customize-format.png | Bin 120217 -> 140132 bytes
.../static/img/03_use-connect/03_schema-editor.png | Bin 121415 -> 284392 bytes
.../03_use-connect/04_schema-editor-conversion.png | Bin 179042 -> 207864 bytes
.../img/03_use-connect/05_adapter-generation.png | Bin 149943 -> 140023 bytes
.../img/03_use-connect/06_connect-create.png | Bin 0 -> 195420 bytes
.../img/03_use-dashboard/01_dashboard-overview.png | Bin 79029 -> 77571 bytes
.../static/img/03_use-dashboard/02_add-widget.png | Bin 146471 -> 179199 bytes
.../img/03_use-dashboard/03_configure-widget.png | Bin 110224 -> 143711 bytes
.../img/03_use-dashboard/04_live-dashboard.png | Bin 123586 -> 163816 bytes
.../01_data-explorer-overview.png | Bin 197200 -> 331164 bytes
.../01_pipeline-overview.png | Bin 91739 -> 95058 bytes
.../02_pipeline-start-dialog.png | Bin 136314 -> 113986 bytes
.../03_pipeline-details.png | Bin 180477 -> 166062 bytes
.../04_pipeline-quick-edit.png | Bin 157995 -> 167241 bytes
.../01_notifications-overview.png | Bin 111204 -> 98031 bytes
.../01_pipeline-editor-overview.png | Bin 133305 -> 198477 bytes
.../02_pipeline-element-info.png | Bin 160189 -> 218451 bytes
.../03_configure-pipeline-element.png | Bin 212210 -> 267100 bytes
.../03_use-pipeline-editor/06_save-pipeline.png | Bin 204465 -> 244482 bytes
28 files changed, 16 insertions(+), 6 deletions(-)
diff --git a/documentation/docs/01_try-overview.md b/documentation/docs/01_try-overview.md
index 0d044705..9fef5f8a 100644
--- a/documentation/docs/01_try-overview.md
+++ b/documentation/docs/01_try-overview.md
@@ -6,7 +6,7 @@ sidebar_label: Overview
This is the documentation of Apache StreamPipes.
-<img class="docs-image docs-image-small" src="/docs/img/01_try-overview/01_streampipes-overview.png" alt="StreamPipes Overview">
+<img class="docs-image docs-image-small docs-image-no-shadow" style="padding: 10px;" src="/docs/img/01_try-overview/01_streampipes-overview.png" alt="StreamPipes Overview">
<div class="container grid col-3">
@@ -85,7 +85,7 @@ This is the documentation of Apache StreamPipes.
</a>,
<a href="extend-sdk-event-model.html">Event Model</a>, <a href="extend-sdk-stream-requirements.html">Stream
Requirements</a>, <a href="extend-sdk-static-properties.html">Static Properties</a>,
- <a href="extend-output-strategies.html">Output Strategies</a>
+ <a href="extend-sdk-output-strategies.html">Output Strategies</a>
</div>
</div>
</div>
diff --git a/documentation/docs/03_use-connect.md b/documentation/docs/03_use-connect.md
index bbd7b58f..bea9b4fa 100644
--- a/documentation/docs/03_use-connect.md
+++ b/documentation/docs/03_use-connect.md
@@ -7,7 +7,7 @@ sidebar_label: StreamPipes Connect
StreamPipes Connect is the module to connect external data sources with Apache StreamPipes directly from the user interface.
StreamPipes Connect offers various adapters for common communication protocols and some specific sensors. Besides connecting data, StreamPipes Connect offers ways to pre-process data without the need to build pipelines and integrates a schema guesser that listens for incoming data and recommends the recognized event schema.
-The screenshot below illustrates the data marketplace, which is the start screen of StreamPipes Connect.
+The screenshot below illustrates the data marketplace, which shown after navigating to "StreamPipes Connect" and then clicking the "New adapter" button at the top.
<img class="docs-image" src="/docs/img/03_use-connect/01_connect-overview.png" alt="StreamPipes Connect Overview">
@@ -19,7 +19,9 @@ Adapters are distinguished a) by the data source concept they provide (data set
Several filter options are available to find a suitable adapter. The configuration of a new adapter starts with selecting one of the available adapters, which starts an assistant that supports the adapter generation.
### Protocol/Basic Settings
-In the first step, basic configurations need to be provided. For instance, for an Apache PLC4X adapter, the IP address of the PLC needs to be provided. After all values are provided, the "Next" button opens the next step.
+In the first step, basic configurations need to be provided. For instance, for an Apache PLC4X adapter, the IP address of the PLC needs to be provided. In this example, we provide basic settings for connecting to an Apache Kafka broker. After all values are provided, the "Next" button opens the next step.
+
+<img class="docs-image" src="/docs/img/03_use-connect/06_connect-create.png" alt="StreamPipes Connect Basic Settings">
### Format Specification
The next step, format generation, is only available for generic adapters which support different message formats to be sent over the corresponding protocol. Think of a message broker that is able to consume messages in both JSON format or binary format.
@@ -53,6 +55,8 @@ For each field (also called event property) of the schema, additional configurat
<img class="docs-image" src="/docs/img/03_use-connect/04_schema-editor-conversion.png" alt="StreamPipes Connect Unit Conversion">
+Assigning a timestamp is mandatory and can be either done by adding a timestamp from the menu, or by choosing an existing field and marking it as timestamp.
+
### Adapter Generation
Finally, the adapter is ready to be started. In the _Adapter Generation_ page, a name and description for the resulting data stream must be provided.
Once started, StreamPipes creates your new adapter and displays a preview of the connected data, which refreshes about once per second.
diff --git a/documentation/docs/03_use-pipeline-editor.md b/documentation/docs/03_use-pipeline-editor.md
index 24eef9a1..39a09cb9 100644
--- a/documentation/docs/03_use-pipeline-editor.md
+++ b/documentation/docs/03_use-pipeline-editor.md
@@ -39,8 +39,6 @@ Further options for a pipeline element can be displayed by hovering over a pipel
* **Compatible element** opens a dialog which shows all pipeline elements that are compatible to the current element's output data stream. The dialog offers an alternative to selecting pipeline elements directly from the pipeline element selection in the top.
* **Pipeline Element Recommendation** opens a dialog which shows all recommended pipeline elements that are compatible the current element's output data stream. The recommendation is based on previously connected pipeline elements and is displayed below.
-<img class="docs-image" src="/docs/img/03_use-pipeline-editor/04_pipeline-element-recommendation.png" alt="StreamPipes Pipeline Element Recommendation">
-
### Pipeline Editor Options
Several pipeline editor options are available in the menu bar of the pipeline assembly:
diff --git a/documentation/website/i18n/en.json b/documentation/website/i18n/en.json
index 65034d3e..e82d2e66 100644
--- a/documentation/website/i18n/en.json
+++ b/documentation/website/i18n/en.json
@@ -2532,6 +2532,10 @@
"version-0.70.0/version-0.70.0-extend-tutorial-data-sources": {
"title": "Tutorial: Data Sources",
"sidebar_label": "Tutorial: Data Sources"
+ },
+ "version-0.70.0/version-0.70.0-community-get-help": {
+ "title": "Get Help",
+ "sidebar_label": "Get Help"
}
},
"links": {
diff --git a/documentation/website/static/css/custom.css b/documentation/website/static/css/custom.css
index 33af8a69..70fe9ff9 100644
--- a/documentation/website/static/css/custom.css
+++ b/documentation/website/static/css/custom.css
@@ -399,6 +399,10 @@ p {
margin-right: auto;
}
+.docs-image-no-shadow {
+ box-shadow: none;
+}
+
.docs-image-small {
max-width: 70%;
margin-top: 20px;
diff --git a/documentation/website/static/img/01_try-installation/03_login.png b/documentation/website/static/img/01_try-installation/03_login.png
index 83944153..82ddaca7 100644
Binary files a/documentation/website/static/img/01_try-installation/03_login.png and b/documentation/website/static/img/01_try-installation/03_login.png differ
diff --git a/documentation/website/static/img/01_try-installation/04_home.png b/documentation/website/static/img/01_try-installation/04_home.png
index 8fcfa85e..db6b1de7 100644
Binary files a/documentation/website/static/img/01_try-installation/04_home.png and b/documentation/website/static/img/01_try-installation/04_home.png differ
diff --git a/documentation/website/static/img/01_try-overview/01_streampipes-overview.png b/documentation/website/static/img/01_try-overview/01_streampipes-overview.png
index 55288f05..09e9b0a4 100644
Binary files a/documentation/website/static/img/01_try-overview/01_streampipes-overview.png and b/documentation/website/static/img/01_try-overview/01_streampipes-overview.png differ
diff --git a/documentation/website/static/img/03_use-connect/01_connect-overview.png b/documentation/website/static/img/03_use-connect/01_connect-overview.png
index f20fef94..5c660026 100644
Binary files a/documentation/website/static/img/03_use-connect/01_connect-overview.png and b/documentation/website/static/img/03_use-connect/01_connect-overview.png differ
diff --git a/documentation/website/static/img/03_use-connect/02_customize-format.png b/documentation/website/static/img/03_use-connect/02_customize-format.png
index c868e851..cf36b18e 100644
Binary files a/documentation/website/static/img/03_use-connect/02_customize-format.png and b/documentation/website/static/img/03_use-connect/02_customize-format.png differ
diff --git a/documentation/website/static/img/03_use-connect/03_schema-editor.png b/documentation/website/static/img/03_use-connect/03_schema-editor.png
index 91f2e788..e55dfd35 100644
Binary files a/documentation/website/static/img/03_use-connect/03_schema-editor.png and b/documentation/website/static/img/03_use-connect/03_schema-editor.png differ
diff --git a/documentation/website/static/img/03_use-connect/04_schema-editor-conversion.png b/documentation/website/static/img/03_use-connect/04_schema-editor-conversion.png
index d686f2c6..46a265d8 100644
Binary files a/documentation/website/static/img/03_use-connect/04_schema-editor-conversion.png and b/documentation/website/static/img/03_use-connect/04_schema-editor-conversion.png differ
diff --git a/documentation/website/static/img/03_use-connect/05_adapter-generation.png b/documentation/website/static/img/03_use-connect/05_adapter-generation.png
index 73835d51..39585a69 100644
Binary files a/documentation/website/static/img/03_use-connect/05_adapter-generation.png and b/documentation/website/static/img/03_use-connect/05_adapter-generation.png differ
diff --git a/documentation/website/static/img/03_use-connect/06_connect-create.png b/documentation/website/static/img/03_use-connect/06_connect-create.png
new file mode 100644
index 00000000..34c79ac0
Binary files /dev/null and b/documentation/website/static/img/03_use-connect/06_connect-create.png differ
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
index 0a1e90e9..395a6a2e 100644
Binary files a/documentation/website/static/img/03_use-dashboard/01_dashboard-overview.png 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
index 72a0678f..94d33dc6 100644
Binary files a/documentation/website/static/img/03_use-dashboard/02_add-widget.png 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
index 8a40f8aa..7e745280 100644
Binary files a/documentation/website/static/img/03_use-dashboard/03_configure-widget.png 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
index d7a8db69..2954a0ae 100644
Binary files a/documentation/website/static/img/03_use-dashboard/04_live-dashboard.png and b/documentation/website/static/img/03_use-dashboard/04_live-dashboard.png differ
diff --git a/documentation/website/static/img/03_use-data-explorer/01_data-explorer-overview.png b/documentation/website/static/img/03_use-data-explorer/01_data-explorer-overview.png
index af6a0d39..009754b4 100644
Binary files a/documentation/website/static/img/03_use-data-explorer/01_data-explorer-overview.png and b/documentation/website/static/img/03_use-data-explorer/01_data-explorer-overview.png differ
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
index 4579e1a4..8cbae29d 100644
Binary files a/documentation/website/static/img/03_use-managing-pipelines/01_pipeline-overview.png 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
index b6814ca0..e5f8d74d 100644
Binary files a/documentation/website/static/img/03_use-managing-pipelines/02_pipeline-start-dialog.png 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
index d0b5e8ea..820d6933 100644
Binary files a/documentation/website/static/img/03_use-managing-pipelines/03_pipeline-details.png 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
index 9b4e842d..b4ec3b82 100644
Binary files a/documentation/website/static/img/03_use-managing-pipelines/04_pipeline-quick-edit.png and b/documentation/website/static/img/03_use-managing-pipelines/04_pipeline-quick-edit.png differ
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
index 688a9876..11b3e8fe 100644
Binary files a/documentation/website/static/img/03_use-notifications/01_notifications-overview.png and b/documentation/website/static/img/03_use-notifications/01_notifications-overview.png differ
diff --git a/documentation/website/static/img/03_use-pipeline-editor/01_pipeline-editor-overview.png b/documentation/website/static/img/03_use-pipeline-editor/01_pipeline-editor-overview.png
index d61c7782..ad8e1b94 100644
Binary files a/documentation/website/static/img/03_use-pipeline-editor/01_pipeline-editor-overview.png and b/documentation/website/static/img/03_use-pipeline-editor/01_pipeline-editor-overview.png differ
diff --git a/documentation/website/static/img/03_use-pipeline-editor/02_pipeline-element-info.png b/documentation/website/static/img/03_use-pipeline-editor/02_pipeline-element-info.png
index 48c287e5..e0185f5a 100644
Binary files a/documentation/website/static/img/03_use-pipeline-editor/02_pipeline-element-info.png and b/documentation/website/static/img/03_use-pipeline-editor/02_pipeline-element-info.png differ
diff --git a/documentation/website/static/img/03_use-pipeline-editor/03_configure-pipeline-element.png b/documentation/website/static/img/03_use-pipeline-editor/03_configure-pipeline-element.png
index 4f857225..2f01faa7 100644
Binary files a/documentation/website/static/img/03_use-pipeline-editor/03_configure-pipeline-element.png and b/documentation/website/static/img/03_use-pipeline-editor/03_configure-pipeline-element.png differ
diff --git a/documentation/website/static/img/03_use-pipeline-editor/06_save-pipeline.png b/documentation/website/static/img/03_use-pipeline-editor/06_save-pipeline.png
index 490463ff..e6124671 100644
Binary files a/documentation/website/static/img/03_use-pipeline-editor/06_save-pipeline.png and b/documentation/website/static/img/03_use-pipeline-editor/06_save-pipeline.png differ