doc(technical-documentation): added first port of technical documentation

This commit is contained in:
Stephan Lo 2024-12-19 14:52:10 +01:00
parent 866dca1655
commit 0a73aa0870
13 changed files with 12 additions and 44 deletions

View file

@ -1,34 +0,0 @@
# User Documentation
## 📋 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 > *
- Developer Portal: Backstage
- [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?
10:40 THU
## 📦 Main features
## ⏱️ Quick start guide
## ⚙️ Configuration
## 🔗 References
- Technical Documentation

View file

@ -22,6 +22,8 @@
## 🧐 What is it?
10:40 THU
## 📦 Main features
## ⏱️ Quick start guide

View file

@ -7,16 +7,16 @@ nav:
- User Documentation: introduction/user-documentation.md
- Technical Documentation: introduction/technical-documentation.md
- User Documentation:
- ArgoCD: userguide/argocd.md
- Backstage: userguide/backstage.md
- CI Workflow: userguide/ci-workflow.md
- Crossplane: userguide/crossplane.md
- edpbuilder: userguide/edpbuilder.md
- Forgejo: userguide/forgejo.md
- Grafana: userguide/grafana.md
- Keycloak: userguide/keycloak.md
- OpenBAO: userguide/openbao.md
- PetClinic: userguide/petclinic.md
- ArgoCD: user-documentation/argocd.md
- Backstage: user-documentation/backstage.md
- CI Workflow: user-documentation/ci-workflow.md
- Crossplane: user-documentation/crossplane.md
- edpbuilder: user-documentation/edpbuilder.md
- Forgejo: user-documentation/forgejo.md
- Grafana: user-documentation/grafana.md
- Keycloak: user-documentation/keycloak.md
- OpenBAO: user-documentation/openbao.md
- PetClinic: user-documentation/petclinic.md
- Technical Documentation:
- Platform concepts:
- 'Code: Software and Workloads': technical-documentation/concepts/1_software-and-workloads/_index.md