Retain docs subfolder in CD

also document CI/CD

.forgejo/workflows/deploy.yml

@@ -27,4 +27,4 @@ jobs:
         run: minify --all -r -o . public
 
       - name: Transfer built files
-        run: lftp -e 'mirror --reverse --delete --no-perms --overwrite ./public httpdocs; exit' ftp://${{ env.FTP_USER }}:${{ secrets.FTP_PASSWORD }}@${{ env.SERVER_URL }}/
+        run: lftp -e 'mirror --delete --no-perms httpdocs/docs ./public/docs; mirror --reverse --delete --no-perms --overwrite ./public httpdocs; exit' ftp://${{ env.FTP_USER }}:${{ secrets.FTP_PASSWORD }}@${{ env.SERVER_URL }}/

README.md

@@ -14,6 +14,19 @@ Beachte, dass die offiziellen Vereinsdokumente nur temporär in diesem Repo unte
 
 `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: