Stephan Lo
62999b41d0
- Archive old docs to docs-old/ for reference - Create new top-down documentation structure: * Platform Overview: purpose, audience, product structure * Components: individual platform components (Forgejo, Kubernetes, Backstage) * Getting Started: onboarding and quick start guides * Operations: deployment, monitoring, troubleshooting * Governance: ADRs, project history, compliance - Add DOCUMENTATION-GUIDE.md with writing guidelines and templates - Add component template (TEMPLATE.md) for consistent documentation - Simplify root README and move technical docs to doc/ folder - Update test configuration: * Exclude legacy content from markdown linting * Relax HTML validation for theme-generated content * Skip link checking for legacy content in test:links * Keep 'task test' clean for technical writers (100% pass) * Add 'task test:full' with comprehensive link checking - Update home page with corrected markdown syntax - Fix internal links in archived content BREAKING CHANGE: Documentation structure changed from flat to hierarchical top-down approach
39 lines
1 KiB
Markdown
39 lines
1 KiB
Markdown
# why we have architectural documentation
|
|
|
|
TN: Robert, Patrick, Stefan, Stephan
|
|
25.2.25, 13-14h
|
|
|
|
## referring Tickets / Links
|
|
|
|
* https://jira.telekom-mms.com/browse/IPCEICIS-2424
|
|
* https://jira.telekom-mms.com/browse/IPCEICIS-478
|
|
* Confluence: https://confluence.telekom-mms.com/display/IPCEICIS/Architecture
|
|
|
|
## charts
|
|
|
|
we need charts, because:
|
|
|
|
* external stakeholders (especially architects) want to understand our product and component structure(*)
|
|
* our team needs visualization in technical discussions(**)
|
|
* we need to have discussions during creating the documentation
|
|
|
|
(*): marker: "jetzt hab' ich das erste mal so halbwegs verstanden was ihr da überhaupt macht"
|
|
(**) marker: ????
|
|
|
|
|
|
## typed of charts
|
|
|
|
* schichtenmodell (frontend, middleware, backend)
|
|
* bebauungsplan mit abhängigkeiten, domänen
|
|
* kontext von außen
|
|
* komponentendiagramm,
|
|
|
|
## decisions
|
|
|
|
* openbao is backend-system, wird über apis erreicht
|
|
|
|
## further topics / new requirements
|
|
|
|
* runbook (compare to openbao discussions)
|
|
* persistenz der EDP konfiguartion (zb postgres)
|
|
* OIDC vs. SSI
|