diff --git a/user_documentation.md b/user_documentation.md index e3a8c76..0463749 100644 --- a/user_documentation.md +++ b/user_documentation.md @@ -2,9 +2,21 @@ ## 📋 Outline - [What is it? (short description what the software does, max 3 sentences)](#what-is-it) + - 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 - [Main features (brief list of main features and enablers - why it is in the stack)](#main-features) + - what are our opinions / core principles and believes that are backed in? + - k8s > * - [Quick start guide](#quick-start-guide) - [Configuration](#configuration) + - structure of the poc (where / how can I change something?) + - how does it work? (bootstrapping++) +- [Known Issues / TODOs](#known-issues) - [References (documentation links etc...)](#references) ## 🧐 What is it? @@ -15,4 +27,4 @@ ## ⚙️ Configuration -## 🔗 References \ No newline at end of file +## 🔗 References