Add content to our documentation
Theodolite's documentation lives inside the docs
folder. It is available at https://cau-se.github.io/theodolite/ but does not provide much content yet.
This ticket summarizes what eventually should be contained in the docs. We might need to create separate sub tickets.
- Home (!164 (merged), !221)
- Getting Started (!164 (merged))
- Fundamental Concepts (!205 (merged))
- Theodolite Benchmarking Method (!205 (merged))
- Metrics (!205 (merged))
- Search Heuristics etc. (!205 (merged))
- Role and Data Model
- Operator
- Theodolite Benchmarking Method (!205 (merged))
- Installation (!164 (merged))
- Running Benchmarks (!164 (merged))
- Creating Executions (!164 (merged))
- Working with the Dashboard
- Analysis
- Installation
- Working with the Notebooks
- Creating Benchmarks (!164 (merged))
- Available Benchmarks (!204 (closed))
- Description of Benchmarks (Use Cases) #40 (closed)
- Development
- Add additional benchmarks/stream processing engines (?)
- Architecture (?)
- Developing locally (?)
- Release process
- API Reference
- CRDs
- Patchers
- Publications (#262 (closed), !290 (merged))
- Contributors (!290 (merged))
Edited by Sören Henning