events/README.md

45 lines
2.8 KiB
Markdown
Raw Normal View History

# DIGIWUE/EVENTS
2025-07-27 15:45:27 +00:00
Das Events-Projekt von DigiWUE soll eine "Drehscheibe" für Veranstaltungen in und um Würzburg sein. Hier sollen möglichst alle Veranstaltungen in Würzburg und Umgebung gesammelt werden. Und von hier aus können sie dann weiter verarbeitet werden. Sei es durch eine Schnittstelle nach [Wuelender](https://wuelender.de) oder als iCal-Feed direkt in deinen eigenen Kalender (möglicherweise gefiltert).
# Roadmap
## Step 1 (Grundlagen schaffen)
### Repository anlegen ✅
### README.md anlegen 👷
### JSON-Datei anlegen 👷
- Jede Veranstaltung bekommt eine eigene JSON-Datei
- als Dateiformat verwenden wir JSON(-LD), und folgen [dem Event-Schema von schema.org](https://schema.org/Event)
- Die "Rohdaten" werden nach Jahr und Monat gegliedert abgelegt, z.B. unter events-data/json/2025/07
- für den Dateinamen haben wir noch kein konkretes Namensschema
- der Dateiname sollte auf .json enden
- der Dateiname sollte den Namen der Location enthalten
- wenn das Event von einer Website gescraped wurde und dort eine ID verwendet wird, sollte die sich im Dateinamen wiederfinden
## Step 2 (Projekt etablieren & stabilisieren)
- [ ] automatische Prüfung auf Duplikate
- [ ] automatische Schemapürfung bei Pull Requests
# Mitmachen
Du möchtest bei uns mitmachen? oder dir fehlt ein Event in unserer Sammlung?
Dies ist ein offenes, (und bewusst) noch relativ unorganisiertes Projekt ... mach einfach mit. Im Moment haben wir leider noch kein bequemes Formular, wo du dein Event einfach eintragen kannst. Am geschicktesten wäre es, wenn du einen Pull Request öffnen könntest und einfach eine neue Datei mit deinem Event beiträgst.
Falls das zu technisch ist, nimm aber gerne einfach Kontakt mit uns auf und/oder lege einen Issue an, und wir finden eine Lösung :)
# Definitionen
Zunächst, vgl. oben, wir legen eine Datei pro Event an.
## Events mit mehreren Auftritten
2025-07-27 16:44:35 +00:00
Bei einem Format wie dem Stramu oder Ringparkfest, wo jede Stunde wer anderes spielt, soll _eine_ Datei für das ganze Stramu angelegt werden. Das Event-Schema von schema.org sieht bereits vor, dass man mit `subEvent` eine (Liste von) Unterevents anlegen kann.
Ziel davon ist, dass die Anzahl an "top-level" Events überschaubar bleibt. [Beispiel, z.B. Ringparkfest Event](https://wuecode.it/digiwue/events/src/branch/main/events-data/json/2025/08/ringparkfest.json)
2025-07-27 15:45:27 +00:00
2025-07-27 16:44:35 +00:00
Bei einem Format wie dem Hafensommer, wo ein Konzert am Abend gespielt wird, soll statt dessen möglichst ein Event pro Abend angelegt werden. Die Eigenschaft `superEvent` kann verwendet werden um auf eine Dachveranstaltung zu verweisen. [Beispiel, z.B. Buntspecht beim Hafensommer](https://wuecode.it/digiwue/events/src/branch/main/events-data/json/2025/08/hafensommer-2338232.json)
2025-07-27 15:45:27 +00:00
## Validierung
Von [schema.org gibt es hier einen Online-Validator](https://validator.schema.org/).