major update
This commit is contained in:
134
docs/index.md
134
docs/index.md
@@ -1,75 +1,93 @@
|
||||
# Dokumentation
|
||||
|
||||
Letzte Aktualisierung: 2026-02-23
|
||||
Letzte Aktualisierung: 2026-03-04
|
||||
|
||||
Diese Dokumente sind für Entwickler gedacht, die die Anwendung warten oder erweitern.
|
||||
Diese Dokumentation folgt einem klaren Lernpfad (einfach -> fortgeschritten) und trennt Lernen von Nachschlagen.
|
||||
|
||||
## Start hier (neue Entwickler)
|
||||
## Lernpfad (chronologisch)
|
||||
|
||||
1. `/docs/erste-schritte.md`
|
||||
- Setup in 30-45 Minuten, erster Login, erster Smoke-Test.
|
||||
2. `/docs/lokale-entwicklung.md`
|
||||
- Täglicher Workflow, Schema-Updates und Qualitätschecks.
|
||||
3. `/docs/erste-aenderung.md`
|
||||
- Schritt-für-Schritt für den ersten kleinen Code-Change.
|
||||
4. `/docs/dokumentation-erweitern.md`
|
||||
- Wie neue Doku-Dateien sauber erstellt, einsortiert und suchbar gemacht werden.
|
||||
5. `/docs/entwickler-checkliste.md`
|
||||
- Finale Checkliste vor Merge/Review.
|
||||
1. `/docs/00-systemueberblick.md`
|
||||
- Produktbild, Kernmodule und Lernziel in 10 Minuten.
|
||||
2. `/docs/01-setup-und-erster-login.md`
|
||||
- Lokales Setup, erster Login, erster Smoke-Test.
|
||||
3. `/docs/02-domain-glossar.md`
|
||||
- Zentrale Begriffe (Tenant, Role, Permission, Scope, Policy).
|
||||
4. `/docs/03-architektur-request-flow.md`
|
||||
- Request-Flow, Schichtmodell, Do/Don't.
|
||||
5. `/docs/04-erste-aenderung-ui.md`
|
||||
- Erste sichere UI-Änderung im Admin-Bereich.
|
||||
6. `/docs/05-erste-aenderung-backend.md`
|
||||
- Erste Backend-/Service-/Repository-Änderung.
|
||||
7. `/docs/06-security-tenant-scope.md`
|
||||
- Sicherheitsgrundlagen, Tenant-Scope, Pflichtchecks.
|
||||
8. `/docs/07-api-erweitern.md`
|
||||
- API-Änderung sauber mit OpenAPI und Tests umsetzen.
|
||||
9. `/docs/08-advanced-scheduler-sso.md`
|
||||
- Fortgeschrittene Themen: Scheduler, Lifecycle, SSO.
|
||||
|
||||
## Architektur und Regeln
|
||||
## Konzepte (Explanation)
|
||||
|
||||
- `/docs/architektur.md`
|
||||
- Startpunkt mit Glossar, Zielbild, Schichtregeln und Sicherheitsleitplanken.
|
||||
- Architektur-Kompass mit verbindlichen Leitplanken.
|
||||
- `/docs/di-container.md`
|
||||
- Wie der AppContainer funktioniert und neue Services registriert werden.
|
||||
- `/docs/sicherheitsmodell.md`
|
||||
- Auth, Permissions, Tenant-Scope, Public/API-Zugriffe.
|
||||
- `/docs/konventionen.md`
|
||||
- Kurze, verbindliche Arbeitsregeln für Code, API und Qualität.
|
||||
- `/docs/lib-standards.md`
|
||||
- Konkrete Do/Don't-Regeln für `lib/**`.
|
||||
|
||||
## Frontend
|
||||
|
||||
- `/docs/frontend-javascript.md`
|
||||
- Frontend-JS-Aufbau, Init-Flow, Grid-Integration und URL-State-Sync.
|
||||
- `/docs/frontend-css.md`
|
||||
- CSS-Struktur, Layering, Vendor-Overrides und Asset-Einbindung.
|
||||
|
||||
## Fach- und Feature-Dokumentation
|
||||
|
||||
- `/docs/benutzerdefinierte-felder.md`
|
||||
- Tenant/User-Zusatzfelder (Typen, Pflege, Filterbarkeit).
|
||||
- `/docs/importe.md`
|
||||
- CSV-Import (V1), Mapping, Fehlercodes, Permission-Modell und Import-Audit.
|
||||
- Vollständiges Sicherheitsmodell (Auth, Permission, Scope).
|
||||
- `/docs/einstellungen-speicherung.md`
|
||||
- Source of truth für Settings (DB) und Datei-Cache-Verhalten.
|
||||
- `/docs/anfragelimits.md`
|
||||
- Login/API-Limits, Scopes, Block-Verhalten.
|
||||
- `/docs/benutzer-lifecycle-policy.md`
|
||||
- Automatische Benutzer-Deaktivierung/Löschung (Policy, Cron, manueller Run).
|
||||
- `/docs/geplante-aufgaben.md`
|
||||
- Zentrale geplante Aufgaben (Scheduler), Job-Konfiguration und Runner-Betrieb.
|
||||
- `/docs/globale-suche.md`
|
||||
- Globale Suche erweitern (Resource, Permission, Mapping, Aside-Integration).
|
||||
- Warum Settings in DB + Datei-Cache koexistieren.
|
||||
|
||||
## API Referenz
|
||||
## Aufgabenanleitungen (How-to)
|
||||
|
||||
- `/docs/globale-suche.md`
|
||||
- Neue Resource in der globalen Suche integrieren.
|
||||
- `/docs/importe.md`
|
||||
- Importfluss, Regeln und Fehlercodes.
|
||||
- `/docs/benutzerdefinierte-felder.md`
|
||||
- Tenant/User-Zusatzfelder korrekt erweitern.
|
||||
- `/docs/geplante-aufgaben.md`
|
||||
- Neue Scheduler-Jobs registrieren und betreiben.
|
||||
- `/docs/auth-sso-smoke-test.md`
|
||||
- SSO-Funktionalität manuell verifizieren.
|
||||
- `/docs/anfragelimits.md`
|
||||
- Rate-Limits verstehen und testen.
|
||||
- `/docs/rbac-permissions-playbook.md`
|
||||
- RBAC-Rechte sauber erweitern (neue Permission, neue Ability, UI/API-Fälle).
|
||||
- `/docs/request-input-validation.md`
|
||||
- Einheitliches Request/Input- und Validation-Muster für Web + API.
|
||||
|
||||
## Referenz (Reference)
|
||||
|
||||
- `/docs/api.md`
|
||||
- API Quick Reference, Auth, Flows, Beispielaufrufe.
|
||||
- `/docs/openapi.yaml`
|
||||
- API Source of truth für Swagger UI.
|
||||
|
||||
## Betriebswissen
|
||||
|
||||
- API-Referenz-Einstieg.
|
||||
- `/docs/konfiguration.md`
|
||||
- Alle ENV-Variablen mit Beschreibung, Standardwerten und Produktions-Checkliste.
|
||||
- `/docs/fehlerbehebung.md`
|
||||
- Häufige Fehlerbilder und schnelle Lösungen.
|
||||
- `/docs/auth-sso-smoke-test.md`
|
||||
- Manueller Smoke-Runbook für Login, Microsoft-Start/Callback, Tenant-SSO-Save und Logout.
|
||||
- ENV-Variablen und Produktions-Defaults.
|
||||
- `/docs/konventionen.md`
|
||||
- Projektweite Konventionen (kurz und verbindlich).
|
||||
- `/docs/lib-standards.md`
|
||||
- Regeln speziell für `lib/**`.
|
||||
- `/docs/benutzer-lifecycle-policy.md`
|
||||
- Policy- und Laufzeitreferenz für User Lifecycle.
|
||||
|
||||
## Betrieb (Operations)
|
||||
|
||||
- `/docs/docker-lokal.md`
|
||||
- Schneller lokaler Docker-Start inkl. typischer Befehle und Troubleshooting.
|
||||
- Lokaler Docker-Betrieb.
|
||||
- `/docs/docker-produktiv.md`
|
||||
- Produktionsbetrieb mit Domain, TLS und `docker-compose.prod.yml`.
|
||||
- Produktivbetrieb mit Docker.
|
||||
- `/docs/docker-betrieb.md`
|
||||
- Einstieg und Navigation zwischen lokaler und produktiver Docker-Doku.
|
||||
- Übersicht und Entscheidungshilfe für Dev/Prod.
|
||||
- `/docs/betriebscheck-doctor.md`
|
||||
- Schneller Systemcheck mit `bin/doctor.php`.
|
||||
- `/docs/fehlerbehebung.md`
|
||||
- Häufige Fehler und schnelle Lösungen.
|
||||
|
||||
## Mitwirken (Contributor Guide)
|
||||
|
||||
- `/docs/lokale-entwicklung.md`
|
||||
- Tages-Workflow für Entwicklung und Checks.
|
||||
- `/docs/entwickler-checkliste.md`
|
||||
- Definition of Done vor Merge.
|
||||
- `/docs/codex-prompts.md`
|
||||
- Standard-Prompts für Skill-basierte Planung und Implementierung.
|
||||
- `/docs/dokumentation-erweitern.md`
|
||||
- Regeln für konsistente, wachsende Doku.
|
||||
|
||||
Reference in New Issue
Block a user