Zum Hauptinhalt springen

Local Setup

Ziel​

Reproduzierbares lokales Setup für Autor:innen, damit Doku-Änderungen inkl. Link-/BPMN-Regeln vor dem PR zuverlässig geprüft werden.

Voraussetzungen​

  • Node.js und pnpm in unterstützter Version.
  • Repository ausgecheckt, Abhängigkeiten installiert.
  • Schreibrechte für lokale Branches und optional CI-Token.

Standard-Workflow für Autor:innen​

  1. pnpm install im site/-Verzeichnis.
  2. Inhalte lokal bearbeiten.
  3. Vor Commit Pflichtchecks ausführen:
    • pnpm run link-check
    • optional pnpm run build für End-to-End-Routing-Validierung.
  4. Erst nach erfolgreichen Checks committen.

Verbindliche Inhaltsregeln beim lokalen Arbeiten​

  • Keine Placeholder (TODO, TBD, Vorlage-Sätze) in finalen Seiten.
  • Pflichtabschnitte laut adding-*-Seiten vollständig ausfüllen.
  • Neue Begriffe auf Glossary mappen.
  • BPMN-relevante Änderungen gegen Traceability Matrix prüfen.

Integration der BPMN-Linking-Regeln in den Autorenworkflow​

Beim Arbeiten an BPMN- oder prozessnahen Seiten gilt zusätzlich:

  1. In BPMN-Dokumentation nur /docs/<slug> oder NO_DOC_LINK: <Grund> verwenden.
  2. Für neue Zielseiten muss Frontmatter slug explizit gesetzt sein.
  3. Nach jeder BPMN-Link-Änderung pnpm run link-check ausführen.
  4. Fehler im Link-Check vollständig beheben (keine „temporären“ Ausnahmen im PR).

Siehe auch: BPMN-Linking Richtlinie, Contributor Guide, Adding Dataset.