Zum Hauptinhalt springen

Versionierung – Dokumentation & Feature-Katalog

Die cockpitOS-Dokumentation (und damit auch der Center-Website Feature-Katalog) kann versioniert werden. So lassen sich Releases abbilden und ältere Stande weiterhin abrufen.


Wie funktioniert die Versionierung?

  • Docusaurus verwaltet Dokumentations-Versionen über den Befehl docs:version.
  • Beim Erzeugen einer neuen Version wird der aktuelle Stand von docs/ in einen versionierten Ordner kopiert (z. B. versioned_docs/version-1.0.0/).
  • In der Navigation erscheint ein Versions-Dropdown; Nutzer können zwischen „Aktuell“ und älteren Versionen (z. B. 1.0.0, 0.9.0) wählen.

Neue Version anlegen

Im Projekt cockpit-docs (Root: cockpit-docs/):

cd cockpit-docs
npm run docusaurus docs:version 1.0.0
  • Erstellt die Version 1.0.0 aus dem aktuellen Stand von docs/.
  • Der Feature-Katalog unter docs/center-website/ wird mitversioniert.
  • Optional: In docusaurus.config.ts kann eine Versions-Badge oder ein Label (z. B. „Aktuell“, „Next“) konfiguriert werden.

Empfehlung für Releases

  • Vor einem Release der Center-Website oder der Doku: Inhalte in docs/center-website/ prüfen und ggf. den Feature-Katalog aktualisieren.
  • Danach: npm run docusaurus docs:version x.y.z ausführen, damit der Katalog zu diesem Release-Stand versioniert ist.
  • Changelog: Optional eine Seite docs/center-website/changelog.md pflegen und in der Sidebar verlinken („Änderungen pro Version“).

Konfiguration (optional)

In docusaurus.config.ts kann das Verhalten der Versionierung angepasst werden, z. B.:

  • lastVersion: 'current' – aktuelle Version als Standard
  • versions – Labels für „current“ und ältere Versionen

Die Standard-Einstellungen des Presets reichen in der Regel aus. Hinweis: Das Versions-Dropdown in der Navbar erscheint erst, nachdem mindestens einmal npm run docs:version x.y.z ausgeführt wurde – bis dahin gibt es nur die „aktuelle“ (unversionierte) Doku.

Nutzungsstatistik: Seitenaufrufe werden anonymisiert erfasst. Im Umami-Dashboard nach diesem Pfad filtern: /center-website/versioning