DevFW-CICD/edp-doc
17
0
Fork 1
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions

docs(outline): added points / remarks

Browse source 
focusing on understanding the project and the tech behind the poc
This commit is contained in:
Patrick Sy 2024-12-04 23:46:40 +01:00
parent 6cf0c13cff
commit eae136e65a
Signed by: Patrick.Sy
GPG key ID: DDDC8EC51823195E
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
user_documentation.md
View file

@ -2,9 +2,21 @@
## 📋 Outline ## 📋 Outline
- [What is it? (short description what the software does, max 3 sentences)](#what-is-it) - [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) - [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) - [Quick start guide](#quick-start-guide)
- [Configuration](#configuration) - [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) - [References (documentation links etc...)](#references)
## 🧐 What is it? ## 🧐 What is it?