chore: sync staging workspace
This commit is contained in:
198
deployment/docs/README.md
Normal file
198
deployment/docs/README.md
Normal file
@@ -0,0 +1,198 @@
|
||||
# Deployment Dokumentation - Index
|
||||
|
||||
**Stand:** 2025-11-01
|
||||
**Status:** ? Vollst?ndige Dokumentation vorhanden
|
||||
|
||||
---
|
||||
|
||||
## ?? Schnellstart
|
||||
|
||||
### F?r schnellen Einstieg
|
||||
|
||||
1. **[quick-start.md](guides/quick-start.md)** ?
|
||||
- Schnellstart-Guide
|
||||
- Pipeline-Status pr?fen
|
||||
- Troubleshooting Quick Reference
|
||||
|
||||
2. **[code-change-workflow.md](guides/code-change-workflow.md)**
|
||||
- Wie Code?nderungen gepusht werden
|
||||
- Automatisches vs. manuelles Deployment
|
||||
- Branching-Strategien
|
||||
- Beispiel-Workflows
|
||||
|
||||
---
|
||||
|
||||
## ?? Detaillierte Guides
|
||||
|
||||
### Setup & Konfiguration
|
||||
|
||||
3. **[setup-guide.md](guides/setup-guide.md)**
|
||||
- Kompletter Setup-Guide von Anfang bis Ende
|
||||
- Infrastructure Deployment
|
||||
- Gitea Runner Setup
|
||||
- Secrets Konfiguration
|
||||
- Schritt-f?r-Schritt Anleitung
|
||||
|
||||
4. **[deployment-commands.md](guides/deployment-commands.md)**
|
||||
- Command-Referenz f?r Deployment
|
||||
- Ansible Playbook Befehle
|
||||
- Docker Compose Kommandos
|
||||
- Troubleshooting Kommandos
|
||||
|
||||
5. **[vault-password.md](guides/vault-password.md)**
|
||||
- Ansible Vault Password Dokumentation
|
||||
- Setup und Verwaltung
|
||||
- CI/CD Integration
|
||||
- Best Practices
|
||||
|
||||
### Deployment-Prozess
|
||||
|
||||
6. **[application-stack.md](reference/application-stack.md)**
|
||||
- Detaillierter Deployment-Ablauf Schritt f?r Schritt
|
||||
- Was passiert bei jedem Deployment
|
||||
- Container-Neustart Details
|
||||
- Rollback-Prozess
|
||||
- Troubleshooting
|
||||
|
||||
---
|
||||
|
||||
## ?? Status & ?bersicht
|
||||
|
||||
### Projekt-Status
|
||||
|
||||
7. **[deployment-summary.md](status/deployment-summary.md)**
|
||||
- Was ist fertig?
|
||||
- Was fehlt noch?
|
||||
- Completion Rate
|
||||
- N?chste Schritte
|
||||
|
||||
8. **[deployment-todo.md](status/deployment-todo.md)**
|
||||
- Aktuelle TODO-Liste
|
||||
- Priorisierte Reihenfolge
|
||||
- Quick Checklist
|
||||
|
||||
### CI/CD Pipeline
|
||||
|
||||
9. **[ci-cd-status.md](status/ci-cd-status.md)**
|
||||
- Aktueller CI/CD Status
|
||||
- Secrets-?bersicht
|
||||
- Runner-Status
|
||||
- Checkliste f?r Completion
|
||||
- Troubleshooting
|
||||
|
||||
### Verbesserungen & Planung
|
||||
|
||||
10. **[improvements.md](status/improvements.md)**
|
||||
- Verbesserungsvorschl?ge
|
||||
- Refactoring-Ideen
|
||||
- Architektur-?berlegungen
|
||||
|
||||
11. **[next-steps.md](status/next-steps.md)**
|
||||
- Geplante n?chste Schritte
|
||||
- Roadmap
|
||||
- Priorit?ten
|
||||
|
||||
---
|
||||
|
||||
## ?? Stack-spezifische Dokumentation
|
||||
|
||||
### Infrastructure Stacks
|
||||
|
||||
- **[stacks/traefik/README.md](../stacks/traefik/README.md)** - Reverse Proxy & SSL
|
||||
- **[stacks/postgresql/README.md](../stacks/postgresql/README.md)** - Database mit Backups
|
||||
- **[stacks/registry/README.md](../stacks/registry/README.md)** - Private Docker Registry
|
||||
- **[stacks/gitea/README.md](../stacks/gitea/README.md)** - Git Server & CI/CD
|
||||
- **[stacks/monitoring/README.md](../stacks/monitoring/README.md)** - Monitoring Tools
|
||||
|
||||
### Application Stack
|
||||
|
||||
- **[stacks/application/README.md](../stacks/application/README.md)** - Application Stack Details
|
||||
- **[ansible/README.md](../ansible/README.md)** - Ansible Playbooks Dokumentation
|
||||
|
||||
### CI/CD
|
||||
|
||||
- **[gitea-runner/README.md](../gitea-runner/README.md)** - Gitea Runner Setup
|
||||
- **[.gitea/workflows/production-deploy.yml](../../.gitea/workflows/production-deploy.yml)** - Haupt-Deployment-Pipeline
|
||||
|
||||
---
|
||||
|
||||
## ?? Security & VPN
|
||||
|
||||
- **[vault-password.md](guides/vault-password.md)** - Ansible Vault Password Dokumentation
|
||||
- **[docs/WIREGUARD-SETUP.md](../../docs/WIREGUARD-SETUP.md)** - WireGuard VPN Setup
|
||||
- **[ansible/playbooks/README-WIREGUARD.md](../ansible/playbooks/README-WIREGUARD.md)** - WireGuard Ansible Playbooks
|
||||
|
||||
---
|
||||
|
||||
## ?? Troubleshooting
|
||||
|
||||
### Workflow-Probleme
|
||||
|
||||
- **[workflow-troubleshooting.md](reference/workflow-troubleshooting.md)** - Workflow Troubleshooting
|
||||
- **[quick-start.md](guides/quick-start.md)** - Troubleshooting Quick Reference
|
||||
|
||||
### Test-Dokumentation
|
||||
|
||||
- **[test-results.md](tests/test-results.md)** - Test Ergebnisse
|
||||
- **[git-deployment-test.md](tests/git-deployment-test.md)** - Git Deployment Tests
|
||||
- **[git-deployment-issue.md](tests/git-deployment-issue.md)** - Git Deployment Issues
|
||||
- **[test-git-deployment.md](tests/test-git-deployment.md)** - Git Deployment Test Guide
|
||||
- **[quick-test.md](tests/quick-test.md)** - Quick Tests
|
||||
- **[recommended-test-flow.md](tests/recommended-test-flow.md)** - Empfohlene Test-Workflows
|
||||
|
||||
---
|
||||
|
||||
## ?? Historie & Logs
|
||||
|
||||
- **[cleanup-log.md](history/cleanup-log.md)** - Cleanup Log
|
||||
- **[cleanup-summary.md](history/cleanup-summary.md)** - Cleanup Zusammenfassung
|
||||
|
||||
---
|
||||
|
||||
## ?? Haupt-Dokumentation
|
||||
|
||||
- **[README.md](../README.md)** - Haupt-Dokumentation & Architektur-?bersicht
|
||||
|
||||
---
|
||||
|
||||
## ?? Empfohlene Lesereihenfolge
|
||||
|
||||
### F?r neue Nutzer
|
||||
|
||||
1. **[quick-start.md](guides/quick-start.md)** - Schneller ?berblick
|
||||
2. **[code-change-workflow.md](guides/code-change-workflow.md)** - Code deployen lernen
|
||||
3. **[deployment-summary.md](status/deployment-summary.md)** - Projekt-Status verstehen
|
||||
|
||||
### F?r Deployment-Verst?ndnis
|
||||
|
||||
1. **[application-stack.md](reference/application-stack.md)** - Wie Deployment funktioniert
|
||||
2. **[ci-cd-status.md](status/ci-cd-status.md)** - CI/CD Pipeline verstehen
|
||||
3. **[setup-guide.md](guides/setup-guide.md)** - Komplette Setup-Anleitung
|
||||
|
||||
### F?r Troubleshooting
|
||||
|
||||
1. **[quick-start.md](guides/quick-start.md)** - Quick Troubleshooting
|
||||
2. **[workflow-troubleshooting.md](reference/workflow-troubleshooting.md)** - Workflow-Probleme
|
||||
3. Stack-spezifische READMEs f?r Details
|
||||
|
||||
---
|
||||
|
||||
## ?? Dokumentations-Standards
|
||||
|
||||
**Alle Dokumentationsdateien:**
|
||||
- Verwenden Markdown-Format
|
||||
- Haben klare ?berschriften-Struktur
|
||||
- Enthalten Code-Beispiele
|
||||
- Haben Troubleshooting-Abschnitte (wenn relevant)
|
||||
- Verlinken zu verwandten Dokumenten
|
||||
|
||||
**Standards:**
|
||||
- ? Beispiele sind ausf?hrbar
|
||||
- ? Pfade sind absolut oder relativ klar
|
||||
- ? Screenshots/Links sind aktuell
|
||||
- ? Status ist klar markiert (?/??/?)
|
||||
|
||||
---
|
||||
|
||||
**Letzte Aktualisierung:** 2025-11-01
|
||||
**Status:** ? Dokumentation vollst?ndig
|
||||
Reference in New Issue
Block a user