2024-12-03 09:55:50 +00:00
|
|
|
# User Documentation
|
|
|
|
|
|
2024-12-04 10:58:53 +00:00
|
|
|
## 📋 Outline
|
2024-12-04 11:47:02 +00:00
|
|
|
- [What is it? (short description what the software does, max 3 sentences)](#what-is-it)
|
2024-12-04 22:46:40 +00:00
|
|
|
- A couple of use cases (different scopes)
|
|
|
|
|
- Why do I need / want this? When should I pass?
|
|
|
|
|
- Compare with other platforms
|
|
|
|
|
- Compare with well-known tools (what parts of my stack / pipeline does this cover?)
|
|
|
|
|
- argo -> vercel
|
|
|
|
|
- monitoring -> data dog
|
|
|
|
|
- forgejo -> graphite
|
2024-12-04 10:58:53 +00:00
|
|
|
- [Main features (brief list of main features and enablers - why it is in the stack)](#main-features)
|
2024-12-04 22:46:40 +00:00
|
|
|
- what are our opinions / core principles and believes that are backed in?
|
|
|
|
|
- k8s > *
|
2024-12-05 07:33:48 +00:00
|
|
|
- Developer Portal: Backstage
|
2024-12-04 10:58:53 +00:00
|
|
|
- [Quick start guide](#quick-start-guide)
|
|
|
|
|
- [Configuration](#configuration)
|
2024-12-04 22:46:40 +00:00
|
|
|
- structure of the poc (where / how can I change something?)
|
|
|
|
|
- how does it work? (bootstrapping++)
|
|
|
|
|
- [Known Issues / TODOs](#known-issues)
|
2024-12-04 11:47:02 +00:00
|
|
|
- [References (documentation links etc...)](#references)
|
2024-12-03 09:55:50 +00:00
|
|
|
|
2024-12-04 10:58:53 +00:00
|
|
|
## 🧐 What is it?
|
2024-12-03 09:55:50 +00:00
|
|
|
|
2024-12-04 10:58:53 +00:00
|
|
|
## 📦 Main features
|
2024-12-03 09:55:50 +00:00
|
|
|
|
2024-12-04 10:58:53 +00:00
|
|
|
## ⏱️ Quick start guide
|
|
|
|
|
|
|
|
|
|
## ⚙️ Configuration
|
|
|
|
|
|
2024-12-04 22:46:40 +00:00
|
|
|
## 🔗 References
|
2024-12-05 07:33:48 +00:00
|
|
|
- Technical Documentation
|
