f5xc-docs-pipeline

Das f5xc-docs-pipeline-Plugin stellt Architekturwissen zur Dokumentations-Pipeline für f5-sales-demo-Repositories bereit. Es leitet beim Content-Authoring an, klärt die Konfigurationszuständigkeit in Multi-Repo-Builds und bietet eine lokale Docker-basierte Vorschau.

v1.0.2 Produktivität

Installation

/plugin install f5xc-docs-pipeline@f5-sales-demo-marketplace

Funktionen

content-author

Leitfaden für das Content-Authoring mit Informationen zu Dateistruktur, MDX-Syntaxregeln, Frontmatter-Anforderungen, Bildreferenzen und lokaler Docker-Vorschau. Wird aktiviert beim Erstellen oder Bearbeiten von docs/-Inhalten, beim Arbeiten mit MDX-Dateien oder beim Einrichten der lokalen Vorschau.

pipeline-navigator

Erläuterung der Dokumentations-Pipeline-Architektur, die beschreibt, wo Änderungen in den vier vorgelagerten Repositories vorgenommen werden: docs-theme, docs-builder, docs-control und docs-icons. Klärt die Konfigurationszuständigkeit (astro.config.mjs, content.config.ts), die Release-Dispatch-Kette und die Verwaltung nachverfolgter Dateien.

Tipp

Verwenden Sie pipeline-navigator, wenn Sie verstehen möchten, welches Repository für eine bestimmte Konfigurationsdatei oder Komponente zuständig ist.

Befehle

/preview-docs

/f5xc-docs-pipeline:preview-docs

Startet einen lokalen Docker-Entwicklungsserver zur Vorschau der Dokumentation. Führt das gemeinsame Docker-Build-Image mit Ihrem lokalen docs/-Verzeichnis aus, das für die Live-Vorschau eingebunden wird.