StefanMoCoAt
5cc1ee6e4d
Integriert umfassende Makefile-Referenz in die Haupt-Dokumentation für bessere Auffindbarkeit und Developer Experience. Änderungen: - README.md: Erweitert "Makefile-Shortcuts" zu "Makefile-Befehle" - Hinzugefügt: Wichtigste Development-Befehle (full-up, services-up, dev-up, test, health-check) - Hinzugefügt: SSoT-Befehle (docker-sync, docker-compose-gen, docker-validate) - Hinzugefügt: Link zur vollständigen Referenz in docker-development.md - +20 Zeilen (Zeilen 292-319) - docs/how-to/start-local.md: Neue Sektion "Weitere Makefile-Befehle" - Hinzugefügt: Verweis auf `make help` - Hinzugefügt: Link zu Docker Development Guide Makefile-Referenz - +6 Zeilen (nach Zeile 39) Kontext: Diese Änderungen bauen auf der vollständigen Makefile-Dokumentation in .junie/guidelines/technology-guides/docker/docker-development.md auf (194 → 756 Zeilen, 50+ Befehle, erstellt am 2025-11-11). Nutzen: - Entwickler: Schnellerer Einstieg durch zentrale Übersicht - Onboarding: Alle wichtigen Befehle auf einen Blick - AI-Assistenten: Konsistente Command-Referenz - Dokumentation: Verbesserte Navigation zwischen How-To-Guides und Referenz Technische Details: Das Makefile umfasst 10 Befehlskategorien: 1. Development Workflow (dev-up, dev-down, dev-restart, dev-logs, dev-info) 2. Layer-spezifisch (infrastructure-*, services-*, clients-*) 3. Full System (full-up, full-down, full-restart, full-logs) 4. Build (build, build-service, build-client) 5. Test (test, test-e2e) 6. Environment (env-setup, env-dev, env-prod, env-staging, env-test, validate) 7. SSoT (versions-show, versions-update, docker-sync, docker-compose-gen, docker-validate, hooks-install) 8. Production (prod-up, prod-down, prod-restart, prod-logs) 9. Monitoring (status, health-check, logs, shell) 10. Cleanup (clean, clean-all) Related: - Vorherige Commits: Makefile-Optimierung (425 Zeilen, strukturiert) - Vorherige Commits: docker-development.md vollständige Aktualisierung - Vorherige Commits: Port-Korrekturen (8080 → 8081) Testing: - ✅ make help zeigt alle Befehle korrekt an - ✅ Links in Markdown funktionieren - ✅ Dokumentation konsistent mit aktuellem Makefile |
||
|---|---|---|
| .. | ||
| architecture | ||
| how-to | ||
| reference | ||
| .frontmatter.schema.json | ||
| README.md | ||
Meldestelle - Dokumentation
📚 Single Source of Truth: YouTrack
Die Hauptdokumentation befindet sich in der YouTrack Wissensdatenbank:
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-0001: Modulare Architektur
- ADR-0002: Domain-Driven Design
- ADR-0003: Microservices
- ADR-0004: Event-Driven Communication
- ADR-0005: Polyglot Persistence
- ADR-0006: Authentication & Authorization (Keycloak)
- ADR-0007: API Gateway Pattern
- ADR-0008: Multiplatform Client Applications
2. C4-Diagramme (PlantUML-Quellen)
Versionierte Diagramm-Quellen für Architekturdokumentation:
3. Developer Guides
Minimale Anleitungen für lokale Entwicklung:
- Lokales Setup – Projekt in 5 Minuten starten
- KDoc Style Guide – Documentations-Konventionen im Code
- Branch-Schutz & PR-Workflow – Git-Workflow
🔄 Automatische Synchronisation
Das Projekt nutzt automatisierte Workflows für Konsistenz:
- KDoc → YouTrack: docs-kdoc-sync.yml – Synchronisiert API-Dokumentation aus Code-Kommentaren nach YouTrack
- Docker SSoT: ssot-guard.yml – Validiert Docker-Versionskonsistenz
- CI Pipeline: ci-main.yml – Hauptpipeline für Build, Tests, Validierung
📋 Documentations-Workflow
Für Code-Änderungen
- KDoc im Code schreiben
- PR erstellen → CI validiert
- Nach Merge → KDoc-Sync pusht automatisch nach YouTrack
Für Architektur-Entscheidungen
- ADR in
docs/architecture/adr/erstellen - PR mit ADR-Review
- Nach Merge → Zusammenfassung in YouTrack verlinken
Für Infrastruktur/Konfiguration
- Dokumentation direkt in YouTrack erstellen
- Bei Code-relevanten Änderungen → im Commit-Message auf YouTrack-Artikel verweisen
❓ Fragen & Support
- Technische Fragen: GitHub Discussions
- Bugs: GitHub Issues
- Architektur-Diskussionen: YouTrack
- Projekt-Dokumentation: YouTrack Wissensdatenbank
Hinweis: Diese README wurde am 30. Oktober 2025 aktualisiert im Rahmen der Documentations-Migration nach YouTrack ( siehe ADR-0009 - folgt).