b35c4087a2
* MP-8 OTHER Implementiere JWT-Authentifizierungs-Filter im Gateway * Fix(ci): Update upload-artifact action to v4 * Fix(ci): Add start command for Keycloak and failure logs * Fix(ci): Remove invalid 'command' property from Keycloak service * Fix(ci): Use KC_DEV_MODE env var to start Keycloak * Fix(ci): Keycloak service was removed from GitHub Actions services and replaced with a manual docker run step that starts Keycloak with the start-dev command. * dev(ci): vereinheitliche Keycloak auf 26.4.2; aktiviere Health im CI (MP-8) * Fix(ci): Stabilize Keycloak startup in integration tests via matrix - Add `dev-file` Keycloak variant to matrix for stability fallback. - Improve wait logic and health checks for Keycloak and Postgres. - Unify Keycloak version to 26.4.2 across codebase. - Add log dumps on failure. * Fix(ci): Die betroffene Datei docs/Visionen-Ideen/Infrastruktur-Strategie_DSGVO-Konformität.md endet aktuell mit genau einer leeren Zeile (Zeile 87). Das entspricht der Regel MD047 („Files should end with a single newline character“). Damit ist deine Korrektur korrekt. * Fix(ci): Repository-wide auto-fix for Markdown files was implemented with a GitHub Actions workflow and a local helper script. EditorConfig and markdownlint ignore files were added to ensure consistent formatting. Instructions for using the auto-fix both via GitHub Actions and locally were provided. * fix(gradle): build.gradle.kts jsBrowser testTask disabled * fix(gradle): build.gradle.kts jsBrowser testTask disabled * Fix(ci): Stabilize integration tests with Keycloak matrix build (MP-8) Introduces a matrix strategy (`keycloak_db: [postgres, dev-file]`) in the integration-tests workflow to mitigate flaky Keycloak starts when using the Postgres service container. - Adds a `dev-file` Keycloak variant for stability fallback. - Improves wait logic and health checks for Keycloak/Postgres. - Unifies Keycloak version to 26.4.2 across codebase (Dockerfile, Compose, ADR, README, tests). - Adds log dumps on failure in CI. - Ensures `KC_HEALTH_ENABLED=true` is set. - Updates related documentation (README, Schlachtplan). - Includes broader Docker SSoT cleanup (versions.toml as source, script updates, env file cleanup, validator hardening). This resolves recurring CI failures related to Keycloak startup and ensures required checks for PRs (#15) are reliable, while also improving overall Docker build consistency. * feat(docs, ci): Implement YouTrack SSoT strategy with Dokka sync (MP-8) - Add Dokka multi-module Gradle configuration and KDoc style guide. - Add GitHub Actions workflow (docs-kdoc-sync.yml) and Python script (youtrack-sync-kb.py) to sync Dokka GFM output to YouTrack KB. - Extend front-matter schema (bc, doc_type) and update relevant pages/stubs. - Adapt CI scripts (validate-frontmatter, check-docs-drift, ci-docs link ignore). - Update README.md to reference YouTrack KB. * feat(docs, ci): Implement YouTrack SSoT strategy with Dokka sync (MP-8) - Add Dokka multi-module Gradle configuration and KDoc style guide. - Add GitHub Actions workflow (docs-kdoc-sync.yml) and Python script (youtrack-sync-kb.py) to sync Dokka GFM output to YouTrack KB. - Extend front-matter schema (bc, doc_type) and update relevant pages/stubs. - Adapt CI scripts (validate-frontmatter, check-docs-drift, ci-docs link ignore). - Update README.md to reference YouTrack KB. * Fix(ci): Replace OpenAPI validator with Spectral Replaces the deprecated 'char0n/swagger-editor-validate' action, which failed due to sandbox issues in GitHub Actions, with the modern '@stoplight/spectral-cli'. This ensures robust OpenAPI specification validation without requiring a headless browser environment. The 'generate-api-docs' job now depends on the successful completion of the Spectral validation. Part of resolving CI failures for PR #15 (MP-8). * Fix(ci): Specify spectral:oas ruleset for OpenAPI validation (MP-8) * Fix(ci): Remove explicit ruleset argument for Spectral validation (MP-8) * Fix(ci): Added a .spectral.yaml file to fix Spectral linting errors. Corrected markdown lint issues in two documentation files. Updated README.md with a new guidelines section to fix link validation errors. * Fix(ci): Markdownlint errors were fixed by adding required blank lines. The Guidelines Validation error was resolved by updating the README.md link. The API Documentation Generator workflow was stabilized by updating paths, tasks, and validation steps. * Fix(ci): Alle vier fehlerhaften GitHub-Action-Prüfungen wurden behoben. Fehler in der OpenAPI-Spezifikation, Probleme mit der Markdown-Linting-Analyse und Validierungsfehler bei Querverweisen wurden korrigiert. Die README.md enthält nun alle erforderlichen Links zu den Richtlinien. * Fix(ci): Markdown linting errors in docs/api/README.md were fixed by specifying languages in fenced code blocks. OpenAPI specification errors in documentation.yaml were resolved by correcting example property types to strings. Cross-reference validation errors in README.md were fixed by adding the missing link to project-standards/coding-standards.md. * Fix(ci): Duplicate heading errors in docs/api/members-api.md were fixed. Cross-reference validation errors for docker-architecture.md were resolved. All originally reported issues passed validation successfully. * Fix(ci): The markdown heading levels in docs/api/members-api.md were corrected from h5 to h4 to fix linting errors. The missing cross-reference link from technology-guides/docker/docker-development.md to docker-overview.md was added. These fixes resolved the original validation and linting errors causing the process to fail. * Fix(ci): Duplicate heading warnings in docs/api/members-api.md were resolved. Cross-reference validation for docker-development.md to docker-architecture.md was fixed. A new unrelated warning about docker-production.md was identified but not addressed. * refactor(ci,docs): Simplify CI pipeline and migrate docs to YouTrack SSoT BREAKING CHANGE: Documentation structure radically simplified - Consolidate 9 GitHub Actions workflows into 1 main pipeline (ci-main.yml) - Remove redundant workflows: ci-docs, markdownlint-autofix, guidelines-validation, api-docs - Delete documentation migrated to YouTrack: api/, BCs/, Visionen-Ideen/, reference/, now/, overview/ - Keep only ADRs, C4 diagrams, and essential dev guides in repo - Update README.md with YouTrack KB links - Create new docs/README.md as documentation gateway - Relax markdown-lint config for pragmatic developer experience Kept workflows: - ssot-guard.yml (Docker SSoT validation) - docs-kdoc-sync.yml (KDoc → YouTrack sync) - integration-tests.yml (Integration tests) - deploy-proxmox.yml (Deployment) - youtrack-sync.yml (YouTrack integration) Related: MP-DOCS-001 * refactor(ci,docs): Simplify CI pipeline and migrate docs to YouTrack SSoT BREAKING CHANGE: Documentation structure radically simplified - Consolidate 9 GitHub Actions workflows into 1 main pipeline (ci-main.yml) - Remove redundant workflows: ci-docs, markdownlint-autofix, guidelines-validation, api-docs - Delete documentation migrated to YouTrack: api/, BCs/, Visionen-Ideen/, reference/, now/, overview/ - Keep only ADRs, C4 diagrams, and essential dev guides in repo - Update README.md with YouTrack KB links - Create new docs/README.md as documentation gateway - Relax markdown-lint config for pragmatic developer experience Kept workflows: - ssot-guard.yml (Docker SSoT validation) - docs-kdoc-sync.yml (KDoc → YouTrack sync) - integration-tests.yml (Integration tests) - deploy-proxmox.yml (Deployment) - youtrack-sync.yml (YouTrack integration) Related: MP-DOCS-001 * refactor(ci,docs): README.md und einige andere Dokumentationen überarbeitet. ports-and-urls.md hinzugefügt. Related: MP-DOCS-001 * refactor(ci,docs): Die Markdownlint-Fehler in README.md und docs/README.md wurden behoben, indem die Überschriftenebenen angepasst, überflüssige Satzzeichen am Ende entfernt und die notwendigen Leerzeilen um Überschriften, Listen, Tabellen und Codeblöcke eingefügt wurden. Das problematische Leerzeichen am Ende in docs/README.md wurde ebenfalls entfernt. Die Dateien entsprechen nun den vorgegebenen Markdownlint-Regeln und sollten die CI-Validierung bestehen. Related: MP-DOCS-001 * refactor(ci,docs): Docker guideline cross-references were fixed and normalized to lowercase labels. Validation scripts confirmed zero cross-reference warnings and consistent metadata. Documentation was updated with a changelog and enhanced README navigation. Related: MP-DOCS-001 * refactor(ci,docs): Docker guideline cross-references were fixed and normalized to lowercase labels. Validation scripts confirmed zero cross-reference warnings and consistent metadata. Documentation was updated with a changelog and enhanced README navigation. Related: MP-DOCS-001 * refactor(ci,docs): Dead links in docs/architecture/adr were fixed by updating URLs to stable sources and adding an ignore pattern for a placeholder link. Specific ADR files had their broken links replaced with valid ones. The markdown-link-check GitHub Action is expected to pass with zero dead links now. Related: MP-DOCS-001 * refactor(ci,docs): Links in ADR checked Related: MP-DOCS-001 * refactor(ci,docs): Links in ADR checked Related: MP-DOCS-001 * refactor(ci,docs): Markdown Regeln ausgebessert Related: MP-DOCS-001 * refactor(ci,docs): Markdown Regeln ausgebessert Related: MP-DOCS-001 * refactor(ci,docs): Markdown Regeln ausgebessert Related: MP-DOCS-001 * Chore: Rerun CI checks with updated branch protection rules
173 lines
9.4 KiB
Markdown
173 lines
9.4 KiB
Markdown
# Meldestelle Project Guidelines
|
|
|
|
**Version:** 2.1.0
|
|
**Last Updated:** 2025-09-15
|
|
**Status:** Reorganized & AI-Optimized
|
|
|
|
---
|
|
|
|
## 📋 Overview
|
|
|
|
This directory contains the comprehensive development guidelines for the Meldestelle project. The guidelines have been restructured into a hierarchical, AI-assistant-optimized format for better navigation, maintainability, and usability.
|
|
|
|
> **🤖 AI-Assistant Note:**
|
|
> All guidelines now include structured metadata headers and AI-specific hints for optimal assistant interaction:
|
|
> - **Metadata:** Each file has guideline_type, scope, audience, and dependencies
|
|
> - **AI Context:** Specific context information for better AI understanding
|
|
> - **Cross-References:** Consistent navigation links between related guidelines
|
|
> - **Quick Reference:** AI-optimized tables and checklists
|
|
|
|
## 🗂️ Guidelines Structure
|
|
|
|
### 📊 Master Guideline
|
|
|
|
- **[Master-Guideline](master-guideline.md)** - Central project guidelines and architectural foundations
|
|
|
|
### 🏗️ Project Standards
|
|
|
|
Core development standards and quality requirements:
|
|
|
|
| Guideline | Scope | AI Context |
|
|
|---------------------------------------------------------------------------|---------------------------------------------|-------------------------------------------------|
|
|
| [Coding Standards](./project-standards/coding-standards.md) | Code quality, naming conventions, patterns | Kotlin standards, Result pattern, value classes |
|
|
| [Testing Standards](./project-standards/testing-standards.md) | Test strategies, tools, coverage | Test pyramid, Testcontainers, debugging |
|
|
| [Documentation Standards](./project-standards/documentation-standards.md) | Documentation language, structure, API docs | German language rules, README templates |
|
|
| [Architecture Principles](./project-standards/architecture-principles.md) | Microservices, DDD, EDA, KMP | Clean Architecture, bounded contexts, MVVM |
|
|
|
|
### 🔧 Technology Guides
|
|
|
|
Technology-specific implementation guidelines:
|
|
|
|
#### Web Applications
|
|
|
|
- **[Web App Guideline](./technology-guides/web-app-guideline.md)** - Compose Multiplatform development for desktop and web clients
|
|
|
|
#### Docker & Infrastructure
|
|
|
|
| Docker Module | Focus Area | AI Context |
|
|
|--------------------------------------------------------------------------------|---------------------------------|---------------------------------------------|
|
|
| [Docker Overview](./technology-guides/docker/docker-overview.md) | Philosophy and principles | Container strategy, security-first approach |
|
|
| [Docker Architecture](./technology-guides/docker/docker-architecture.md) | Services and version management | Service categories, centralized versions |
|
|
| [Docker Development](./technology-guides/docker/docker-development.md) | Development workflow | Makefile commands, debugging, hot-reload |
|
|
| [Docker Production](./technology-guides/docker/docker-production.md) | Production deployment | Security hardening, SSL/TLS, monitoring |
|
|
| [Docker Monitoring](./technology-guides/docker/docker-monitoring.md) | Observability setup | Prometheus, Grafana, health checks |
|
|
| [Docker Troubleshooting](./technology-guides/docker/docker-troubleshooting.md) | Problem resolution | Common issues, best practices, workflows |
|
|
|
|
### 🔄 Process Guides
|
|
Development process and workflow guidelines:
|
|
|
|
- **[Trace Bullet Guideline](./process-guides/trace-bullet-guideline.md)** - End-to-end architecture validation cycle
|
|
|
|
## 🎯 Quick Navigation for AI Assistants
|
|
|
|
### Common Development Tasks
|
|
|
|
| Task | Primary Guidelines | Supporting Guidelines |
|
|
|------------------------------|-------------------------------------------|-------------------------------------------|
|
|
| **New Feature Development** | Architecture Principles, Coding Standards | Testing Standards, Docker Development |
|
|
| **Frontend Development** | Web App Guideline | Architecture Principles, Coding Standards |
|
|
| **Backend Service Creation** | Architecture Principles, Coding Standards | Docker Development, Testing Standards |
|
|
| **Infrastructure Setup** | Docker Architecture, Docker Development | Docker Overview, Docker Monitoring |
|
|
| **Production Deployment** | Docker Production | Docker Architecture, Docker Monitoring |
|
|
| **Testing Implementation** | Testing Standards | Coding Standards, Docker Development |
|
|
| **Documentation Writing** | Documentation Standards | All related technical guidelines |
|
|
| **Troubleshooting Issues** | Docker Troubleshooting | Docker Development, Docker Monitoring |
|
|
|
|
### Key Architectural Decisions
|
|
|
|
1. **Microservices Architecture** - See [Architecture Principles](./project-standards/architecture-principles.md)
|
|
2. **Domain-Driven Design** - See [Architecture Principles](./project-standards/architecture-principles.md)
|
|
3. **Event-Driven Architecture** - See [Architecture Principles](./project-standards/architecture-principles.md)
|
|
4. **Kotlin Multiplatform** - See [Web App Guideline](./technology-guides/web-app-guideline.md)
|
|
5. **Docker-First Infrastructure** - See [Docker Overview](./technology-guides/docker/docker-overview.md)
|
|
|
|
### Technology Stack Quick Reference
|
|
|
|
| Layer | Technologies | Guidelines |
|
|
|--------------------|---------------------------------------------|-------------------------------------------|
|
|
| **Frontend** | Kotlin Multiplatform, Compose Multiplatform | Web App Guideline |
|
|
| **Backend** | Spring Boot, Kotlin, Clean Architecture | Architecture Principles, Coding Standards |
|
|
| **Infrastructure** | Docker, PostgreSQL, Redis, Kafka, Consul | Docker Guides |
|
|
| **Monitoring** | Prometheus, Grafana, Zipkin | Docker Monitoring |
|
|
| **Testing** | JUnit 5, MockK, Testcontainers | Testing Standards |
|
|
|
|
## 🚀 Getting Started
|
|
|
|
### For Developers
|
|
|
|
1. Start with [Master-Guideline](./master-guideline.md) for project overview
|
|
2. Review [Architecture Principles](./project-standards/architecture-principles.md) for architectural foundations
|
|
3. Follow [Coding Standards](./project-standards/coding-standards.md) for development practices
|
|
4. Use [Docker Development](./technology-guides/docker/docker-development.md) for local setup
|
|
|
|
### For AI Assistants
|
|
|
|
1. Each guideline includes structured metadata and AI context
|
|
2. Use the `ai_context` field for understanding guideline scope
|
|
3. Cross-reference related guidelines through navigation sections
|
|
4. Leverage quick reference tables for rapid information access
|
|
|
|
### For Project Managers
|
|
|
|
1. [Trace Bullet Guideline](./process-guides/trace-bullet-guideline.md) for current development cycle
|
|
2. [Master-Guideline](./master-guideline.md) for project standards overview
|
|
3. Individual guidelines for specific team coordination
|
|
|
|
## 🤖 Automatisierung und Validierung
|
|
|
|
Das Guidelines-System verfügt über umfassende Automatisierungsfeatures:
|
|
|
|
### 🔗 Automatische Validierung
|
|
|
|
- **Link-Validierung:** `.junie/scripts/validate-links.sh` - Cross-Referenzen und YAML-Konsistenz
|
|
- **Template-System:** `.junie/scripts/create-guideline.sh` - Automatische Guideline-Erstellung
|
|
- **Pre-commit Hook:** `.junie/scripts/pre-commit-guidelines.sh` - Lokale Validierung vor Commits
|
|
- **CI/CD-Integration (optional):** `.github/workflows/ci-main.yml` (Job: `validate-docs`) - Markdown-Lint und Link-Check für kritische Docs
|
|
|
|
### 📋 Verfügbare Templates
|
|
|
|
- **Project-Standards:** `project-standard-template.md`
|
|
- **Technology-Guides:** `technology-guideline-template.md`
|
|
- **Process-Guides:** `process-guide-template.md`
|
|
|
|
**Detaillierte Dokumentation:** [AUTOMATION-FEATURES.md](../AUTOMATION-FEATURES.md)
|
|
|
|
## 📝 Guideline Metadata Format
|
|
|
|
All guidelines follow this metadata structure for AI optimization:
|
|
|
|
```yaml
|
|
---
|
|
guideline_type: "project-standards" # oder "technology" oder "process-guide"
|
|
scope: "specific-area-identifier"
|
|
audience: ["developers", "ai-assistants", "architects", "devops", "project-managers"]
|
|
last_updated: "YYYY-MM-DD"
|
|
dependencies: ["list-of-related-guidelines"]
|
|
related_files: ["relevant-project-files"]
|
|
ai_context: "Brief description for AI understanding"
|
|
---
|
|
```
|
|
|
|
## 🔍 Guidelines Maintenance
|
|
|
|
### Update Process
|
|
|
|
1. **Content Changes** → Update specific guideline file
|
|
2. **Structural Changes** → Update README.md navigation
|
|
3. **New Guidelines** → Add to appropriate category and update index
|
|
4. **Deprecated Guidelines** → Archive and update references
|
|
|
|
### Quality Assurance
|
|
|
|
- All guidelines include AI-optimized metadata
|
|
- Cross-references are maintained and validated
|
|
- Navigation links are consistent across guidelines
|
|
- Content follows documentation standards
|
|
|
|
---
|
|
|
|
**Last Restructuring:** 2025-09-13 - Complete hierarchical reorganization with AI optimization
|
|
**Next Review:** As needed based on project evolution
|
|
|
|
**Questions or suggestions?** Update this README.md or reach out to the development team.
|