StefanMoCoAt
33f1c0fab5
### Summary - Updated root `README.md` to reflect the new Backend/Frontend structure. - Rewrote the project structure section to show `backend/` and `frontend/` with their submodules, and `docs/adr` + `docs/c4`. - Corrected Gradle module examples from old `:members:members-service` paths to `:backend:services:results:results-service` for both `bootRun` and `test` examples. - Verified links now point to `docs/adr` and `docs/c4`. - Updated `docs/README.md` to ensure flat paths: - Confirmed ADR and C4 links point to `adr/` and `c4/` respectively. - Updated the footer note to today’s date and linked ADR-0009. These changes align the docs with the consolidated, flat documentation layout and the finalized module structure. Ref: MP-30
98 lines
3.6 KiB
Markdown
98 lines
3.6 KiB
Markdown
# Meldestelle - Dokumentation
|
||
|
||
## 📚 Single Source of Truth: YouTrack
|
||
|
||
Die Hauptdokumentation befindet sich in der **YouTrack Wissensdatenbank**:
|
||
|
||
👉 **[Meldestelle Command Center](https://meldestelle-pro.youtrack.cloud/articles/MP-A-24)**
|
||
|
||
### Was du in YouTrack findest
|
||
|
||
- 🏗️ **Bounded Context Dokumentation** (Members, Horses, Events, Masterdata)
|
||
- 📡 **API-Referenz** (automatisch aus KDoc generiert)
|
||
- 🚀 **Deployment-Guides** (Proxmox, Cloudflare, Nginx)
|
||
- 🔐 **Sicherheit-Konfigurationen** (Keycloak, GitHub Secrets)
|
||
- 💡 **Roadmap & Visionen**
|
||
- 📊 **Architektur-Diagramme** (interaktiv)
|
||
|
||
---
|
||
|
||
## 📂 Was im Repository bleibt
|
||
|
||
### 1. Architecture Decision Records (ADRs)
|
||
|
||
Architekturentscheidungen sind Teil der Code-Historie und werden im Repository versioniert:
|
||
|
||
- [ADR Übersicht](adr)
|
||
- [ADR-0001: Modulare Architektur](adr/0001-modular-architecture-de.md)
|
||
- [ADR-0002: Domain-Driven Design](adr/0002-domain-driven-design-de.md)
|
||
- [ADR-0003: Microservices](adr/0003-microservices-architecture-de.md)
|
||
- [ADR-0004: Event-Driven Communication](adr/0004-event-driven-communication-de.md)
|
||
- [ADR-0005: Polyglot Persistence](adr/0005-polyglot-persistence-de.md)
|
||
- [ADR-0006: Authentication & Authorization (Keycloak)](adr/0006-authentication-authorization-keycloak-de.md)
|
||
- [ADR-0007: API Gateway Pattern](adr/0007-api-gateway-pattern-de.md)
|
||
- [ADR-0008: Multiplatform Client Applications](adr/0008-multiplatform-client-applications-de.md)
|
||
- [ADR-0009: Final KMP Architecture](adr/0009-final-kmp-architecture.md)
|
||
|
||
### 2. C4-Diagramme (PlantUML-Quellen)
|
||
|
||
Versionierte Diagramm-Quellen für Architekturdokumentation:
|
||
|
||
- [C4 Context](c4/01-context-de.puml)
|
||
- [C4 Container](c4/02-container-de.puml)
|
||
- [C4 Component - Events Service](c4/03-component-events-service-de.puml)
|
||
|
||
### 3. Developer Guides
|
||
|
||
Minimale Anleitungen für lokale Entwicklung:
|
||
|
||
- **[Lokales Setup](how-to/start-local.md)** – Projekt in 5 Minuten starten
|
||
- **[KDoc Style Guide](how-to/kdoc-style.md)** – Documentations-Konventionen im Code
|
||
- **[Branch-Schutz & PR-Workflow](how-to/branchschutz-und-pr-workflow.md)** – Git-Workflow
|
||
|
||
---
|
||
|
||
## 🔄 Automatische Synchronisation
|
||
|
||
Das Projekt nutzt automatisierte Workflows für Konsistenz:
|
||
|
||
- **KDoc → YouTrack**: [docs-kdoc-sync.yml](../.github/workflows/docs-kdoc-sync.yml) – Synchronisiert API-Dokumentation
|
||
aus Code-Kommentaren nach YouTrack
|
||
- **Docker SSoT**: [ssot-guard.yml](../.github/workflows/ssot-guard.yml) – Validiert Docker-Versionskonsistenz
|
||
- **CI Pipeline**: [ci-main.yml](../.github/workflows/ci-main.yml) – Hauptpipeline für Build, Tests, Validierung
|
||
|
||
---
|
||
|
||
## 📋 Documentations-Workflow
|
||
|
||
### Für Code-Änderungen
|
||
|
||
1. KDoc im Code schreiben
|
||
2. PR erstellen → CI validiert
|
||
3. Nach Merge → KDoc-Sync pusht automatisch nach YouTrack
|
||
|
||
### Für Architektur-Entscheidungen
|
||
|
||
1. ADR in `docs/adr/` erstellen
|
||
2. PR mit ADR-Review
|
||
3. Nach Merge → Zusammenfassung in YouTrack verlinken
|
||
|
||
### Für Infrastruktur/Konfiguration
|
||
|
||
1. Dokumentation direkt in YouTrack erstellen
|
||
2. Bei Code-relevanten Änderungen → im Commit-Message auf YouTrack-Artikel verweisen
|
||
|
||
---
|
||
|
||
## ❓ Fragen & Support
|
||
|
||
- **Technische Fragen**: [GitHub Discussions](https://github.com/StefanMoCoAt/meldestelle/discussions)
|
||
- **Bugs**: [GitHub Issues](https://github.com/StefanMoCoAt/meldestelle/issues)
|
||
- **Architektur-Diskussionen**: [YouTrack](https://meldestelle-pro.youtrack.cloud)
|
||
- **Projekt-Dokumentation**: [YouTrack Wissensdatenbank](https://meldestelle-pro.youtrack.cloud/knowledge-bases)
|
||
|
||
---
|
||
|
||
**Hinweis**: Diese README wurde am 8. Dezember 2025 aktualisiert im Rahmen der Dokumentations-Migration nach YouTrack
|
||
(siehe [ADR-0009](adr/0009-final-kmp-architecture.md)).
|