Die Dokumentation unter Commonsbooking.org open source stellen und statisch generieren lassen

[datengraben]

Die aktuelle Seite wird über Wordpress gepflegt. Die Typografischen Inhalte der Doku sehen nicht kompliziert aus, das könnte man auch per Markdown files hosten. Wärt ihr offen eine Dokumentation über Github als markdown o.Ä. zu hosten und vielleicht auch im Repository zu intergrieren?

Vorteile:

• Ein commit im Repo kann zu einer Code-Änderung auch direkt die Doku-Änderung enthalten
• Ein Issue/Pull-Request zu einem Feature/Bug der Software oder einem Fehler in der Doku kann direkt mit dem Commit verbunden werden der ihn repariert
• Der Content der Doku kann als Pull-Request auch von aussenstehende geändert/verbessert werden (vielleicht für mehrsprachigen Content wie Englisch interessant)
• Markdown-Files können direkt via Github editiert und vorgeschaut werden

Nachteile:

• Einmaliger Aufwand, Wordpress via Github befüllen oder statischen Website-Generator konfigurieren
• Wordpress-Editor kann nicht mehr genutzt werden

Was denkt ihr darüber? Der Content der Doku könnte unter /docs im Repo wielebenwir/commonsbooking liegen und den Inhalt unter https://commonsbooking.org/dokumentation ersetzen oder die komplette Seite commonsbooking.org.

[datengraben]

Der Import von Github Markdown Files als eigene Posts in Wordpress sollte hiermit funktionieren, habe ich selber noch nicht gemacht oder getestet https://github.com/vaakash/git-it-write

[datengraben]

Statische generatoren gibt es auch einige. Ich kenne mich mit Hugo aus, da ich ein paar eigene Websites damit generiere. Docsy basiert auch auf Hugo und wird zum Beispiel für Kubernetes Doku verwendet.