- Use a single entry point for user+developer guide called "documentation"
Proposed Structure
- Documentation
- Try StreamPipes
- Installation (Docker+Docker Compose, docker-compose.lite.yml for OSx, Windows, Linux)
- Interactive Tutorial*
- Concepts
- Data streams /sets
- Adapter/Connect (specific and generic adapters)
- Pipeline (Stream, Processors, Sinks, Messaging)
- Glossary
- Use StreamPipes
- Pipeline Editor (Features: data preview, user guidance, recommendations, validation, pipeline rollback etc)
- StreamPipes Connect (Features: step wise connection, unit transformation, event time, domain properties)
- Notifications
- Live Dashboard
- Data Explorer
- Configurations
- Pipeline Elements Repository
- Adapters
- Processors
- Sinks
- Deploy StreamPipes
- Single Node: Docker
- Cluster: Kubernetes
- ...
- Extend StreamPipes
- Development setup (Docker+Docker Compose, required ports to be open, docker-compose up
f dockercompose.dev.yml, IntelliJ) - Tutorials: Adapter
- Archetypes
- SDK Reference (Stream Requirements, Static Properties, Output Strategies, Event Model)
- Adapter
- Processor
- Sinks
- Debugging
- Package and Deploy
- Development setup (Docker+Docker Compose, required ports to be open, docker-compose up
- "Technicals" - under the hood
- Architecture
- User guidance
- Runtime Wrappers (Standalone, Distributed)
- Messaging: Transport Protocols (Kafka, Mqtt, Jms, etc.)
- Data formats: Transport Formats (JSON, CBOR, etc.)
- Pipeline Element Registration
- ...
- Monitoring/Debugging?
- coming "soon"
- Contribute
- Core & UI developement (reference to wiki)
- FAQ
- Try StreamPipes
*Interactive tutorials
(home screen)
- Connect water pipe simulator
- Create first pipeline with water pipe simulator
- Create first dashboard