search

th-koeln / mi-master-wtw

Infos zum Schwerpunkt Weaving the Web im Medieninformatik Master an der TH Köln
https://th-koeln.github.io/mi-master-wtw/
MIT License
7 stars 39 forks source link

Boilerplate für Veranstaltungswebsites #73

Open cnoss opened 5 years ago

cnoss commented 5 years ago

Für zukünftige Veranstaltungswebsites soll eine Boilerplate entwickelt werden, damit diese (Jekyll-) Seiten schneller und konsistenter erstellt werden können. Eine wesentliche Herausforderung hierbei ist, wie neue Features in das Gesamtsystem einfließen können. Hier gilt es auch ein sinnvolles Deployment/ Update/ Git Konzept und einen dazugehörigen Prozess zu entwickeln und zu dokumentieren. Eine erste Version einer Boilerplate ist bereits vorhanden.

Aufwand/Budget(Std.): Recherche/Basiskonzept 8 Std., danach bitte noch mal mit mir verhandeln.

flobraeun commented 5 years ago

Das Boilerplate wurde mit einem Jekyll Theme umgesetzt. Zunächst war geplant dieses über Git Subtree umzusetzten, es wurde jedoch festgestellt, dass ein Jekyll Theme viele Vorteile bietet und inzwischen auch mit GitHub Pages nutzbar ist. Durch diese Änderung der Umsetzung konnte die Style Library aus zeitlichen Gründen nicht vollständig entwickelt werden und wurde lediglich prototypisch umgesetzt.

Bei der Entwicklung wurden mehrere Repositories erstellt, die nachfolgend aufgelistet und kurz beschrieben sind.

mi-jekyll-theme

Dieses Repository beinhaltet das Jekyll Theme, welches von allen Veranstaltungswebsite genutzt werden soll. In der README ist der Aufbau des gesamten Projekts beschrieben. Als Basis dieses Themes wurden die bestehenden Veranstaltungswebsites verwendet. Dabei wurden die Website auf gemeinsame und unterschiedliche Features untersucht und es wurde eine gemeinsame Basis entwickelt, auf der diese und zukünftige Websites basieren können.

mi-jekyll-boilerplate

Hierbei handelt es sich um das Boilerplate, das für neue Veranstaltungswebsites genutzt werden kann. Das Boilerplate wurde auf Basis der bestehenden Veranstaltungswebsites entwickelt und so aufgebaut, dass möglichst alle Features des Themes hier bereits eingerichtet sind, sodass nicht benötigte Features bei der Nutzung einfach entfernt werden können.

mi-master-wtw

Um die Integration des Themes in eine bestehende Veranstaltungswebsite zu demonstrieren wurde ein Fork dieses mi-master-wtw Repositories erstellt und mit der Verwendung des Themes konfiguriert.

mi-style-lib

Die mi-style-lib ist eine erste Version einer allgemeinen Style Library für die Medieninformatik. Diese Library basiert auf den Styles der bestehenden Veranstaltungswebsites und ist lediglich ein erster Schritt hin zur Entwicklung einer allgemeinen Style Library der Medieninformatik (wie in #4 und #75 beschrieben). Der Fokus lag auf der Entwicklung des Themes und des Boilerplates, nicht auf der Style Library. Das mi-style-lib Repository wird jedoch bereits im Theme über Git Subtree verwendet. Styles speziell für die Veranstaltungswebsites sind nicht in der Library, sondern in einer SCSS-Datei im Theme. Hierbei wird über das Theme die allgemeine Verfügbarkeit und das Deployment ausgeführt. In der README ist die Nutzung der Library kurz beschrieben.