website/README.md

Chaostreff Backnang Website

Dieses Repository enthält alle Dateien für die statische Webpräsenz des Chaostreff Backnang e.V.: https://chaostreff-backnang.de.

Technische Verantwortung für dieses Repository hat aktuell kleines Filmröllchen. Inhaltliche Verantwortung liegt beim Verein.

Technisches

Es wird zola als Seitengenerator benutzt. Für Installationsanweisungen zu Zola siehe dort. Für eine lokale Entwicklungsinstanz inkl. Hot-Reloading einfach zola serve ausführen. Die fertig gebaute Seitenstruktur (zola build), die auch so öffentlich ausgeliefert wird, wird im public-Ordner erzeugt.

Der content-Ordner enthält den Markdown-Quelltext für die HTML-Seiten, die Startseite befindet sich in _index.md. Im static-Ordner befinden sich diverse statische Dateien.

Beachte, dass die offiziellen Vereinsdokumente nur temporär in diesem Repo untergebracht werden, bis wir einen CI-Workflow haben, der diese automatisch aus dem Quell-LaTeX baut.

templates enthält das HTML-Template für alle Seiten (page.html).

Deployment

Die Seite wird mit CD automatisch zu unserem Webhoster deployed. Nach dem Generieren der Seite werden die Dateien per FTP zum Webhoster hochgeladen. Leider ist das bei Netcup die einzige Möglichkeit außer einem dedizierten Git-Repo, ein automatisches Deployment durchzuführen.

Folgende Variablen werden von der CD-Pipeline genutzt und müssen in den Forgejo-Einstellungen nach Bedarf angepasst werden:

• SERVER_URL: Domain des FTP-Servers. Achtung: es muss hier immer die direkte Subdomain unter netcup.net benutzt werden. Die Zertifikate für FTP-TLS-Authentifizierung sind nämlich nur für *.netcup.net gültig. Die vollständige URL hätte die Form hosting202205.abcdef.netcup.net, wofür das Zertifikat nicht gültig ist. Allerdings ist der FTP-Server auch unter abcdef.netcup.net erreichbar.
• FTP_USER: Benutzername unseres FTP-Accounts
• FTP_PASSWORD: Passwort unseres FTP-Accounts (Actions-Secret). Der Login geschieht mittels FTP-TLS-Auth.
• SITE_URL: Basis-URL unserer Website. Im Regelbetrieb ist das https://chaostreff-backnang.de. Ist diese Variable falsch eingestellt, wird die Website falsch angezeigt und Links sind defekt.

Der docs-Ordner wird vom CD so behalten, wie er aktuell ist. Das Satzungs-Repo https://git.ctbk.de/vorstand/satzung ist dafür zuständig, die offiziellen Dokumente bei Änderungen in diesen Ordner hochzuladen.

Mitwirken

Wir nehmen in der Regel nur folgende Arten an Pull-Requests und Issues ohne Weiteres an:

• Barrierefreiheit
• Rechtschreibung und Grammatik
• Technische Korrekturen (Syntax, JavaScript-Bugfixes, CI-Updates)

Bitte jegliche Textdateien mit prettier formatieren.

Sollte es größere Änderungs- und Verbesserungswünsche geben, wird das im Vorhinein diskutiert und muss mindestens am Vorstand vorbei. Schau dafür eher auf unseren üblichen Kommunikationskanälen vorbei, anstatt hier ein Issue oder PR zu erstellen.

Lizenzen

Die sonstigen Inhalte dieses Repos und der Website sind, soweit nicht anders angegeben, unter der Creative Commons „Namensnennung“ 4.0-Lizenz verfügbar, siehe LICENSE. Jeglicher JavaScript-Quellcode ist unter der MIT-Lizenz verfügbar, siehe LICENSE-CODE.