search

OPUS4 / userdoc

User manual for OPUS 4.
https://opus4.github.io/userdoc
1 stars 12 forks source link

Seiten mit Vagrant rendern #95

Closed j3nsch closed 2 years ago

j3nsch commented 2 years ago

Wir verwenden Jekyll für die Seiten der Dokumentation. Um sie sich lokal anschauen zu können bevor sie zu GitHub gepushed werden, müssen einige Voraussetzungen erfüllt sein. Dafür soll eine Vagrant Konfiguration erstellt werden.

j3nsch commented 2 years ago

@alw-bsz, @sigwei, @stconradr Die Vagrant Konfiguration für die Doku-Seiten funktioniert. Wenn man mit vagrant up die VM erzeugt, werden am Ende Hinweise zur Nutzung ausgegeben. Man kann sich das auch im Vagrantfile anschauen. In der VM kann man Jekyll starten und dann vom Host-System mit dem Browser auf die Seiten zugreifen. Die Seiten können mit den normal installierten Editoren im Host-System, Windows, Mac, Linux, editiert werden.

j3nsch commented 2 years ago

Es kommen bei der Ausführung von Jekyll ein paar Warnungen. Vermutlich müssen wir irgendwann auf neuere Versionen umsteigen, evtl. Ruby anders installieren, um die neueste Version zu bekommen. Der Vorteil mit Vagrant ist, dass wir das an einer Stelle pflegen können und jeder dann diese Konfiguration nutzen kann.