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 77aa5bdc8 Update download section
77aa5bdc8 is described below
commit 77aa5bdc8928c32df9a5b72610985306492ea99c
Author: Dominik Riemer <[email protected]>
AuthorDate: Tue Feb 18 08:53:48 2025 +0100
Update download section
---
docs/05_deploy-docker.md | 10 --
website-v2/src/components/download/DownloadBox.tsx | 5 +
.../src/components/download/DownloadFolder.tsx | 4 +-
.../src/components/download/DownloadMoreInfo.tsx | 2 +-
.../version-0.97.0/05_deploy-docker.md | 16 ---
.../version-0.97.0/user-guide-for-quickstart.md | 134 ---------------------
6 files changed, 8 insertions(+), 163 deletions(-)
diff --git a/docs/05_deploy-docker.md b/docs/05_deploy-docker.md
index 93102a266..08dbfaa19 100644
--- a/docs/05_deploy-docker.md
+++ b/docs/05_deploy-docker.md
@@ -78,16 +78,6 @@ Stopping the **full** option:
docker-compose -f docker-compose.nats.yml down
#docker-compose -f docker-compose.nats.yml down -v
```
-Starting the **quickstart** option:
-```bash
-docker-compose -f docker-compose.quickstart.yml build script-runner
-docker-compose -f docker-compose.quickstart.yml up -d
-#go to `http://localhost` after all services are started
-```
-Stopping the **quickstart** option:
-```bash
-docker-compose -f docker-compose.quickstart.yml down
-```
## Update services
To actively pull the latest available Docker images use:
diff --git a/website-v2/src/components/download/DownloadBox.tsx
b/website-v2/src/components/download/DownloadBox.tsx
index 40c5a097f..a7269aeb3 100644
--- a/website-v2/src/components/download/DownloadBox.tsx
+++ b/website-v2/src/components/download/DownloadBox.tsx
@@ -49,11 +49,16 @@ const DownloadBox = (props) => {
</div>
<div className="row">
<div className="alert alert-info" role="alert"
style={{marginLeft: '20px', marginRight: '20px'}}>
+ <p>
The above release file should be verified using the PGP
signatures and the <a
href="https://downloads.apache.org/streampipes/KEYS";>project
release KEYS</a>. See the official ASF <a
target="asf"
href="https://www.apache.org/dyn/closer.cgi#verify";>verification
instructions</a> for a
description of using the PGP and KEYS files for verification.
A SHA512 checksum is also provided as an
additional verification method.
+ </p>
+ <p>
+ Find the latest release notes here: <a
href={`https://github.com/apache/streampipes/blob/dev/RELEASE_NOTES.md`}>Release
notes</a>
+ </p>
</div>
</div>
</div>
diff --git a/website-v2/src/components/download/DownloadFolder.tsx
b/website-v2/src/components/download/DownloadFolder.tsx
index 6ca38f3c3..99f4e86c7 100644
--- a/website-v2/src/components/download/DownloadFolder.tsx
+++ b/website-v2/src/components/download/DownloadFolder.tsx
@@ -11,8 +11,8 @@ const DownloadFolder = (props) => (
</span>
</div>
<div className="col-md-11 col-9">
- In a command prompt, open the folder <code>installer/compose/</code>
and run <code>docker-compose up -d</code> , or you could try the Quickstart
mode with predefined example asset. Please follow the <a
- target="asf"
href="https://streampipes.apache.org/docs/next/deploy-docker/";>Docker
Deployment</a> to explore this new mode.
+ In a command prompt, open the folder <code>installer/compose/</code>
and run <code>docker-compose up -d</code>. Please follow the <a
+ target="asf"
href="https://streampipes.apache.org/docs/next/deploy-docker/";>Docker
Deployment</a> guide to explore additional installation options.
</div>
</div>
</li>
diff --git a/website-v2/src/components/download/DownloadMoreInfo.tsx
b/website-v2/src/components/download/DownloadMoreInfo.tsx
index 63629ed28..d92c45b8f 100644
--- a/website-v2/src/components/download/DownloadMoreInfo.tsx
+++ b/website-v2/src/components/download/DownloadMoreInfo.tsx
@@ -12,7 +12,7 @@ const DownloadMoreInfo = (props) => (
</div>
<div className="col-md-11 col-9">
For a detailed description of the installer and migration guides,
read the <a
- href="/docs/try-installation/"> installation guide</a>
+ href="/docs/try-installation/"> installation guide </a>
or learn about advanced <a href="/docs/deploy-docker/">Docker</a> or
<a
href="/docs/deploy-kubernetes/">K8s</a> deployment setups.
</div>
diff --git a/website-v2/versioned_docs/version-0.97.0/05_deploy-docker.md
b/website-v2/versioned_docs/version-0.97.0/05_deploy-docker.md
index 93102a266..5dba2de8b 100644
--- a/website-v2/versioned_docs/version-0.97.0/05_deploy-docker.md
+++ b/website-v2/versioned_docs/version-0.97.0/05_deploy-docker.md
@@ -78,22 +78,6 @@ Stopping the **full** option:
docker-compose -f docker-compose.nats.yml down
#docker-compose -f docker-compose.nats.yml down -v
```
-Starting the **quickstart** option:
-```bash
-docker-compose -f docker-compose.quickstart.yml build script-runner
-docker-compose -f docker-compose.quickstart.yml up -d
-#go to `http://localhost` after all services are started
-```
-Stopping the **quickstart** option:
-```bash
-docker-compose -f docker-compose.quickstart.yml down
-```
-
-## Update services
-To actively pull the latest available Docker images use:
-```bash
-docker-compose pull
-```
## Upgrade
To upgrade to another StreamPipes version, simply edit the `SP_VERSION` in the
`.env` file.
diff --git
a/website-v2/versioned_docs/version-0.97.0/user-guide-for-quickstart.md
b/website-v2/versioned_docs/version-0.97.0/user-guide-for-quickstart.md
deleted file mode 100644
index ec4166a2f..000000000
--- a/website-v2/versioned_docs/version-0.97.0/user-guide-for-quickstart.md
+++ /dev/null
@@ -1,134 +0,0 @@
----
-id: user-guide-for-quickstart
-title: Quickstart Tour
-sidebar_label: Quickstart Tour
----
-
-Apache StreamPipes is a self-service Industrial IoT toolbox to enable
non-technical users to connect, analyze and explore IoT data streams.
-
-Quickstart Mode, ideal for first-time users, allows users to interact with
pre-set pipelines, dashboards, and data views to experience StreamPipes'
functionalities for IIoT.
-This page provides an overview of StreamPipes' features in Quickstart Mode,
guiding users on how to utilize them effectively.
-
-:::info
-Do you have StreamPipes already running in the quickstart mode? If not, simply
run the command `docker-compose -f docker-compose.quickstart.yml build
script-runner` and `docker-compose -f docker-compose.quickstart.yml up -d` from
the directory `installer/compose`.
-:::
-
-First of all, a user needs to log in to the system. The default login
credentials are `[email protected]` as username and `admin` as
password.
-The credentials for the user are specified during the installation process.
-
-
-## Home
-After logging in, the user is redirected on to the home page.
-The home page gives an overview over the different features available in the
StreamPipes UI.
-
-On the left, the navigation menu can be seen.
-You can either use the icons on the left side or click on the menu icon on the
-top left to open the details view of the navigation menu.
-
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/01_home.png" alt="Home"/>
-</div>
-
-## Connect
-The _Connect_ view provides an overview of all existing adapters to let
StreamPipes connect data sources.
-
-With StreamPipes Connect it is possible to connect new data sources in
StreamPipes with just a few clicks.
-It is also possible to connect specific data sources or connect generic
sources like message brokers or databases.
-If the event schema of the data source is unknown, the system tries to infer
the schema by extracting some sample data and analysing it.
-
-In the Quickstart Mode, we use the Machine Data Simulator and Data Stream to
simulate the factory machine condition data and environmental data, just click
the `START ALL ADAPTERS` button. This starts all existing adapters to offer
data sources for pipelines.
-
-
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/03_adapters.png" alt="Adapters"/>
-</div>
-
-## Pipelines
-The _Pipelines_ view provides an overview of all existing pipelines.
-
-A pipeline in Apache StreamPipes describes the transformation process from a
data stream to a data sink. Typically, a pipeline consists of at least one data
stream (or data set), zero or more data processors and at least one data sink.
-Existing pipelines can be managed using this pipeline view. For instance,
users can start and stop pipelines or delete them when they are not longer
needed.
-
-In the pipeline page, we could see there are 5 pipelines, click the `START ALL
ADAPTERS` button. This starts all existing adapters to offer data sources for
pipelines.
-
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/02_pipelines.png" alt="Pipeline
Overview"/>
-</div>
-
-
-In smart factory , monitoring and analysing machine parameters are essential
steps to ensure machine safety, and minimizing downtime. In the industrial
machine cooling system or hydraulic machines, water level could be an important
part of monitoring parameters to ensure machine's performance and safety.
-Using the `Water level trend analysis` pipeline as an example, by clicking the
`Show pipeline` button, we could see the details of the pipeline as the
following figure.
-
-<div class="my-carousel docs-carousel">
-<img src="/img/quickstart/user-guide/07_water_level_trend_pipeline.png"
alt="Pipeline Detail"/>
-</div>
-
-The pipeline contains 3 major parts:
-- **Data source**:
- - Machine Data Simulator (Water Level).
-- **Data Processors**:
- - Trend Detector: to analyse the water level increase speed within specified
time, when Trend Detector find the speed is reaching the limit, it will trigger
the notification.
- - Welford Change Detection: to calculate the variance of the mean and change
of the water level over a specified time
- - Boolean Counter: to count each `overflow` status change from `false` to
`true`.
- - Numerical Filter: when `overflow` status change from `false` to `true`
reaches 5 times, it will trigger Notification.
-- **Data Sinks**:
- - Notification: to push a notification when the measured parameter condition
reaches the set condition of the trigger, which are sent to Notification
interface.
- - Data Lake: to store the events in the internal data lake, offering data
for dashboard and data explorer.
-
-
-## Dashboard
-The _Dashboard_ can be used for multiple use cases.
-
-It is a good way to live monitor a running system in a dashboard, it also
could be used during the pipeline development to get a fast feedback from newly
created pipelines.
-Currently 10 different types of visualizations are available, including line
charts, various map visualizations and data tables. The Dashboard feature
allows you to select and view real-time data from specific pipelines that
interest you.
-
-In the Quickstart mode, we offer three distinct dashboards, each designed for
a specific application scenario. These dashboards include factory temperature
monitoring, sensor running condition monitoring, and real-time machine data
monitoring.
-
-
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/04_dashboard.png" alt="Live
dashboard"/>
-</div>
-
-As shown in the following figure, taking the `Smart Machine Monitor` as an
example, the dashboard can showcase real-time data for monitoring machine
parameters such as pressure and water level.
-
-<div class="my-carousel docs-carousel">
- <img
src="/img/quickstart/user-guide/08_smart_machine_monitor_dashboard.png"
alt="Smart Machine Monitor"/>
-</div>
-
-## Data Explorer
-The _Data Explorer_ can be used for visualizing and exploring data streams
that have been persisted using the Data Lake sink.
-
-Once your data has been stored in the data lake, you can navigate to the data
explorer tab to craft a new data view with the widgets of your preference.
-In StreamPipes, a data view is a compilation of related widgets, which can be
data visualizations or plots, all assigned to a specific date and time range.
By default, this range encompasses the last 15 minutes of the current date and
time. However, you also have the flexibility to choose from predefined ranges,
such as a day or a month, or to customize the exact date and time range that
you wish to investigate.
-
-In the Quickstart Mode, we try to demonstrate the StreamPipes' practicability
and convenience in data analysis, by providing example data views for specific
application scenarios, including machine running condition monitor, problem
analysis, factory environment monitor.
-
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/05_data_explorer.png" alt="Data
Explorer"/>
-</div>
-
-As shown in the following figure, taking the `Machine Running Condition
Monitoring of Water Level and Pressure` data view as an example, the data
explorer can show real-time machine data as different types of widgets,
depending on what the user needs, to help analyse the data better.
-In the machine running condition scenarios, we pay attention to the
distribution of water level and pressure, as well as the pressure change
condition.
-
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/09_machine_running_data_view.png"
alt="Data Explorer Detail"/>
-</div>
-
-
-
-## Notifications
-The _Notifications_ can be used for notifying someone when a urgent situation
occurs.
-
-A notification can be created by using the notification sink in the pipeline
editor.
-The message can be nicely configured in the message editor.
-It is also possible to embed values of the event that triggered the
notification.
-All available properties are presented in the notification configurator.
-
-In Quickstart mode, StreamPipes have pre-defined several notification trigger
in the example pipelines, when you click the `Notification` button in the upper
right corner, you could see the notification dialog.
-<div class="my-carousel docs-carousel">
- <img src="/img/quickstart/user-guide/06_notifications.png"
alt="Notifications"/>
-</div>
-
-
-Congratulations! You've just finished Quickstart user guide of StreamPipes.
-
