[
https://issues.apache.org/jira/browse/STREAMPIPES-581?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Dominik Riemer updated STREAMPIPES-581:
---------------------------------------
Fix Version/s: (was: 0.70.0)
> Restructure documentantion
> ---------------------------
>
> Key: STREAMPIPES-581
> URL: https://issues.apache.org/jira/browse/STREAMPIPES-581
> Project: StreamPipes
> Issue Type: Task
> Components: Documentation
> Reporter: Florian Micklich
> Assignee: Florian Micklich
> Priority: Major
>
> restructure documentation as described here
> https://lists.apache.org/thread/vrl71vl41bygs9n00sx6j31dmwn5r6n9
> new structure with more subfolders
> add descriptions and examples for adapter
> reorganize pipeline elements
> add description and example for sinks
> {code:java}
> First Idea of Structure
> • Introduction:
> ◦ Overview
> ◦ Basic Elements (former StreamPipes Concept)
> ◦ Time in StreamPipes (Why timestamp is important in the data?)
> ◦ Semantic in StreamPipes
> ◦ Other Topics?
> ◦ Installation
> ▪ Basic Installation
> ▪ Docker Deployment
> ▪ K8s / K3s
> ▪ Use SSL
> ▪ Security
> ◦ Getting Help
> • Overview (Basic GUI Explanation and Introduction for each GUI point and
> why it is implemented (short description text) for example Dashboard why
> Dashboard, what you can do. Basically little more deep diver than Basic
> Elements section. Section with Most of the Screenshots, So easy to maintain
> due changes)
> ◦ Login Page and Basics
> ◦ Welcome Page
> ◦ Pipelines
> ◦ Connect
> ◦ Dashboard
> ◦ Data Explorer
> ◦ Apps (deprecated?)
> ◦ Install Pipeline Elements
> ◦ Asset Management
> ◦ File Management
> ◦ Configuration & User Prefences
> ◦ Notification
> • Data Source Elements
> ◦ Why Adapter. Connect to the Real World
> ◦ What Kind of Sources (Data Set vs Data Stream / Categories)
> ◦ Basic Adapter Setup in 4 Steps (at the moment)
> ▪ Step 1 Settings
> ▪ Step 2 Select Format
> • JSON with Description for Array Field / GeoJSON / Single
> Object / Array with Short Data Examples
> • XML
> • CSV
> • Image
> ▪ Step 3 configure fields
> • Different between Measurement, Dimension Header
> • Add Nested / Add static Value / Add Timestamp
> • Edit fields (Big Thinks. Also)
> • Preview
> ▪ Step4 start adapters
> • Settings / Description (why Important and where can I find
> this info later on?)
> • Remove Duplicates / Reduce event rates /Persist events
> ◦ Connect Adapters IIOT Overview
> ▪ Apache Kafka with Example Sources
> ▪ Apache Pulsar
> ▪ File Set
> ▪ File Stream
> ▪ ...
> ◦ Connect Adapters Overview
> ◦ • ...
> ◦ How To Adapter
> ▪ Setup Adapter Example 1
> ▪ Setup HTTPS Adapter
> ◦ Technical Concept of Adapters (Dev Part???)
> • Data Processors
> • Data Sinks
> • Create Pipeline
> • Dashboard
> • Assets
> {code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
