Quellcode der Website des Bits'n'Bugs e.V.

Unsere Website darf gerne von allen Vereinsmitgliedern, aber auch Externen, bearbeitet werden. Stellt dazu einfach einen Pull Request. Wie das Ergebnis aussehen wird, könnt ihr gleich auf https://preview.erlangen.ccc.de/PullRequestNummer/ sehen. Das Passwort, das ihr dafür braucht, kann euch bestimmt ein anderes Vereinsmitglied verraten ;).

Mini-Anleitung zum Artikel schreiben

Wir verwenden Hugo als statisches CMS mit dem Blowfish-Theme. Das ermöglicht uns, die Website im Markdown-Format zu pflegen, das Vielen bewusst oder unbewusst geläufig ist. Die Syntax ist ganz einfach:

# Quellcode der Website des Bits'n'Bugs e.V.
...

## Eine Unterüberschrift

Hier kann Text stehen. Zeilenumbrüche
sind egal und gelten wie ein Leerzeichen. Wir können den Text
**fett** oder _kursiv_ setzen oder als `Code formatieren`.
[Links können absolut](https://erlangen.ccc.de/) oder
[relativ](/bnb/website) gesetzt werden, und Bilder funktionieren
recht ähnlich: ![Das Bits'n'Bugs-Logo, ein Käfer](/static/favicon-32x32.png)

- Sogar Aufzählungen
- gehen sehr einfach
- mit Strichen davor

Die einzelnen Artikel liegen jeweils in content/posts/*/index.md. Im gleichen Verzeichnis finden sich auch dazugehörige Bilder; von besonderer Bedeutung ist das featured.jpg oder featured.png, das als Artikelbild auf der Hauptseite genutzt wird.

Die "besonderen" Seiten liegen direkt unter content/, wie z.B. impressum.md oder _index.md.

Klonen und Pull Request

Wenn ihr etwas verbessern wollt oder einen neuen Artikel schreiben wollt, könnt ihr entweder in einen neuen Branch pushen, wenn ihr die Berechtigung dazu habt, oder einfach das Repo klonen und eure Änderungen dorthin pushen; das funktioniert immer, wenn ihr einen Account habt.

Danach erstellt ihr ganz normal einen Pull Request. Der wird von einem der Maintainer überprüft, und entweder akzeptiert oder wir senden euch Feedback mit Änderungsvorschlägen.

Automatisches Deployment

Sobald ihr euren Pull Request angelegt habt, wird eure neue Version automatisch in der CI-Pipeline gebaut und auf Syntaxfehler überprüft. Wenn etwas nicht passt, seht ihr das am roten Kreuz neben eurem Commit, das ganze dauert wenige Minuten.

Wenn alles glattgegangen ist, könnt ihr das Ergebnis eurer Änderung nach kurzer Zeit unter https://preview.erlangen.ccc.de/PullRequestNummer/ sehen. Es dauert nach auftauchen des grünen Hakens noch eine Minute, bis der Cronjob wieder vorbeikommt.

Wenn ihr also beispielsweise den Pull-Request #4 eröffnet habt, so ist eure Pull-Request-Nummer die 4. Solange dieser PR offen ist (also weder geschlossen noch gemerged), seht ihr die Vorschau unter https://preview.erlangen.ccc.de/4.

Das Passwort, das ihr dafür braucht, kann euch bestimmt ein anderes Vereinsmitglied oder das Vereinswiki verraten ;).

Selber bauen

Ihr könnt natürlich die Seite auch lokal bei euch bauen. Dafür müsst ihr das Repo mitsamt seiner Submodule klonen (also git clone --recursive, oder später dann ein git submodule update --init) und Hugo installieren.

(Die aktuell verwendete Versionsnummer verrät euch ein beherztes grep 'hugo/releases' .forgejo/workflows/production.yml.)

Dann ruft ihr ./build.sh auf und nutzt einen lokalen Webserver eures Vertrauens zum ausliefern.