Cccccrystall commented on code in PR #116: URL: https://github.com/apache/streampipes-website/pull/116#discussion_r1370133705
########## docs/user-guide-for-quickstart.md: ########## @@ -0,0 +1,133 @@ +--- +id: user-guide-for-quickstart +title: Quickstart Tour +sidebar_label: Tour +--- + +StreamPipes is a framework that enables domain experts to model and execute stream processing pipelines in a big data infrastructure. +The graphical user interface of StreamPipes is a web application that provides an easy to use solution for domain experts. + +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. + + +First of all, a user needs to log in to the system. The default login credentials are ``[email protected]``, password ``admin`` +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> + + +## 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 'START ALL PIPELINES' button, we could start all the predefined pipelines. + +<div class="my-carousel docs-carousel"> + <img src="/img/quickstart/user-guide/02_pipelines.png" alt="Pipeline Overview"/> +</div> + + + 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. + + +The pipeline contains 3 major parts: Review Comment: Hi, @bossenti ! Thanks for the suggestion! I have added the description of this part in 59 row as follows: 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. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
