Adoc Modul Build Workflow

Beschreibung

Eine Modul Dokumentation besteht aus .adoc Dokumenten und einer fest vordefinierten Antora Modul Struktur, die dann im Antora Context beim Antora Build Deploy Vorgang zu HTML Dokumenten umgewandelt und bereitgestellt werden.

Aufbau

siehe Antora Modul Struktur

Workflow

Variante 1: neue Modul Dokumentation erstellen

Neu Erstellung local
- Mit dem Modul Template Generator kann gleich bei erstellen eines neuen Moduls ein locales Repository mit erstellt werden
Im Terminal in das zu bearbeitende Repository wechseln
Commit erstellen
Initialen Push tätigen
Im Gitlab das remote Repository erstellen
Repositories abgleichen

Variante 2: Update einer bestehenden Modul Dokumentation

Erst muss das local Repository auf einen aktuellen Stand gebracht werden

git pull

Änderungen vornehmen und zum Repository hinzufügen

git add .

Commit erstellen

git commit -m "[TASK] <push description>"

Push der Änderungen zum Repository

git push

Branch Version Handling

Unterschiedliche Versionen eines Moduls werden in folgender Schreibweise gestaltet:

Das Modul Prefix ist bei Modulen immer v

<Prefix><Version Number>

v1.0, v2.x, ...