forked from DevFW-CICD/website-and-documentation

Stephan Lo f797af114b test: configure comprehensive markdown linting with Docsy best practices

Configure markdownlint with rules aligned to technical documentation
standards and Docsy theme conventions.

Design Decisions:
- Enable core quality rules (heading hierarchy, consistent list styles)
- Allow inline HTML for Docsy shortcodes and components
- Permit bare URLs (common in technical documentation)
- Make code block language hints optional (pragmatic for existing content)
- Set maximum 2 consecutive blank lines (balanced readability)
- Enforce single trailing newline (POSIX standard)
- Use asterisk for unordered lists (consistency)
- Allow 2-space list indentation (Markdown standard)

Auto-fixed Issues:
- Converted dash lists to asterisk lists (568 fixes)
- Removed trailing spaces (211 fixes)
- Added missing trailing newlines (74 fixes)
- Added blank lines around lists and headings (100+ fixes)

Remaining Style Warnings (intentionally accepted):
- MD029: List numbering variations in meeting notes (75 instances)
- MD036: Bold text for section headers in ADRs (13 instances)
- MD025: Multiple H1 in notes/brainstorming docs (10 instances)
- MD032/MD022: Minor spacing variations (15 instances)

Test Results:
✅ Hugo build: 227 pages generated successfully
✅ HTML validation: No errors
✅ Link checking: All links valid (except dev-only livereload)
✅ Markdown linting: Only non-critical style warnings remain

The configuration balances strict quality checks with pragmatic
flexibility for diverse content types (documentation, ADRs, meeting
notes, tutorials).

2025-10-23 14:25:46 +02:00

1.7 KiB

Raw Blame History

arbeitsteilung arcihtekur, nach innen und nach aussen

Sebastiano, Stefan, Robert, Patrick, Stephan 25.2.25, 14-15h

montags-call

Sebasriano im montags-call, inklusive florian, mindestens interim, solange wir keinen architektur-aussenminister haben

workshops

nach abstimmung mit hasan zu platform workshops
weitere beteiligung in weiteren workshop-serien to be defined

programm-alignment

sponsoren finden
erledigt sich durch die workshop-serien

interne architekten

robert und patrick steigen ein
themen-teilung

produkt struktur

edp standalone ipcei edp

architektur themen

stl

produktstruktur application model (cnoe, oam, score, xrd, ...) api backstage (usage scenarios) pipelining 'everything as code', deklaratives deployment, crossplane (bzw. orchestrator)

ggf: identity mgmt

nicht: security monitoring kubernetes internals

robert

pipelining kubernetes-inetrnals api crossplane platforming - erzeugen von ressourcen in 'clouds' (e.g. gcp, und hetzner :-) )

patrick

security identity-mgmt (SSI) EaC und alles andere macht mir auch total spass!

einschätzungen

ipceicis-pltaform ist wichtigstes teilprojekt (hasan + patrick)
offener punkt: workload-steuerung, application model (kompatibility mit EDP)
thema security, siehe ssi vs. oidc
wir brauchen eigene workshops zum definieren der zusammenarbiets-modi

committements

patrick und robert nehmen teil an architektur

offen

sebastian schwaar onboarding? (>=50%) --- robert fragt
- alternative: consulting/support anfallsweise
- hält eine kubernetes einführungs-schulung --> termine sind zu vereinbaren (liegt bei sophie)

1.7 KiB Raw Blame History