updated README

This commit is contained in:
Lukas Schulz 2021-03-08 17:28:54 +01:00
parent 2ee783b65b
commit 471cc6486c

View file

@ -1,3 +1,23 @@
# Knotenpunkt-Alpen.de
um die Seite zu aktuelisieren erstmal die Dateien in diesem Repo aktualisieren und dann auf dem Mattermost container in `/var/www/html/about` ein `git pull` ausführen.
## Aufbau der Seite
Die Seite ist sehr schnell und unstrukturiert geschrieben.
Dateien wie das Logo oder das Handbuch liegen in dem Unterordner `assets` und Bilder grundsätzlich im Unterordner `images`.
Die Website ist komplett statisches html, alles Design findet nur über CSS statt, javascript ist aus der Website verbannt.
## Developement
Einfach das Repo klonen und bei kleineren Änderungen einfach einen Commit ausführen, bei größeren Änderungen einen eigenen Branch erzeugen und dann einen Merge-Request stellen.
Dadurch, dass die Website komplett statisch ist liegt alles was man braucht in diesem Repo und es muss einfach nur die index.html aufgerufen werden.
## Deployment
Um den aktuellen Stand des Git-Repos zu deployen, muss man sich auf dem Container einloggen (entweder per Web-UI oder `ssh` und `pct enter 109`), dann in das Verzeichnis `/var/www/html/about` und dort ein `git pull` ausführen.