diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..60a05aec66a64007d6d98db95fb60305ea5dd22d --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +--- +title: README +status: hidden +--- + +# Inhaltsrepo der Fachgruppenwebseite + +[](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website-data/-/commits/main) +[](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website/-/commits/master) + +Dieses Repo beinhaltet den Inhalt der [Webseite der Fachgruppe Informatik](https://fg.informatik.uni-goettingen.de/). + +Die Seitenkonfiguration, das Theme und wie die ganze Seite gebaut wird, findest du im [Meta Repo](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website). + +## Ordnerstruktur + +Im [images Ordner](images/) können Bilder gespeichert werden. + +Im [pages Ordner](pages/) werden s.g. "pages" gespeichert. Die sind quasi so ähnlich wie "articles", sind aber für so Sachen wie Impressum und Datenschutzerklärungen gedacht. + +Alle sonstigen Ordner repräsentiern eine Kategorie. Kategorien werden in der [siteconf.json im Meta Repo](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website/-/blob/master/siteconf.json) konfiguriet. + +Dateien die in gar keinem Ordner abgelegt werden (also z.B. diese [README.md](README.md)), werden implizit in die `misc` Kategorie getan. + + +## Markdown + + +### Metadaten + +Eine jede Markdown Datei **muss** mit einem Metadaten Header anfangen. +Dieser muss mindestens `title` gesetzt haben. + +Ein Metadaten Header sind z.B. wie folgt aus: +```markdown +--- +title: Mein toller Artikel +slug: mein_toller_artikel +status: published +tags: droggelbecher,foo,bar,hallo,welt +lang: de +--- +``` + +Weiter Informationen zu möglichen Metadaten gibt es in der [Pelican Dokumentation](https://docs.getpelican.com/en/4.7.2/content.html#file-metadata). + +### Syntax + +(TODO Markdown Syntax konkret dokumentieren.) + +Die Markdown Syntax baut auf der Markdown Syntax von Pandoc auf. Es sind einige Extensions aktiviert, um die Syntax möglichst ähnlich zur Hedgedoc Markdown Syntax zu machen. + +## Menüleiste & Startseite anpassen + +Die Menüleiste und die Startseite werden über die [siteconf.json Datei im Meta Repo](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website/-/blob/master/siteconf.json) konfiguriet. + +Die Menüleiste kann (derzeitig nur) auf Kategorien und Artikel/Seiten verlinken. Um auf eine Seite in der Menüleiste zu verlinken, muss diese im Markdown Header, muss diese im Markdown Header den `slug` Wert gesetzt haben. + +## Deployment + +Sobald man in einem der beiden Repos Änderungen macht, wird automatisch eine CI/CD Pipeline ausgeführt, welche die neuen Änderungen baut und direkt auf der Webseite veröffentlicht. +Dies kann bis zu 5 Minuten dauern. + +Falls die Seite nach dem Durchführen der Pipelines nicht aktuallisiert ist, muss man vielleicht die Seite mit Strg + F5 neuladen, damit der Browser die Änderungen auch übernimmt. + +## Technologie + +Die Seite wird mit [Pelican v4.7.2](https://blog.getpelican.com/) gebaut.