README ergänzt
This commit is contained in:
parent
b849ae0809
commit
78f95c6961
1 changed files with 40 additions and 12 deletions
52
README.md
52
README.md
|
@ -1,16 +1,44 @@
|
|||
# DIGIWUE/EVENTS
|
||||
|
||||
Das Evevts-Projekt von DigiWUE soll eine "Drehscheibe" für Veranstaltungen in und um Würzburg sein. Hier sollen alle Veranstaltungen gesammelt. Und von hier aus können sie dann auch in andere Systeme übernommen werden, durch verschiedene Filter und Formate.
|
||||
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).
|
||||
|
||||
## Step 1
|
||||
### Repository anlegen [x]
|
||||
### README.md anlegen [o]
|
||||
### JSON-Datei anlegen [o]
|
||||
- JSON-Datein folgen den [JSON-Schema](https://schema.org/)
|
||||
- Jede Veranstaltung ist eine eigene JSON-Datei
|
||||
- Die Dateien sind in Ordner nach Jahr und Monat gespeichert
|
||||
# Roadmap
|
||||
|
||||
## Step 2
|
||||
### Duplicate checken [ ]
|
||||
### PRs Format checken [ ]
|
||||
...
|
||||
## 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
|
||||
|
||||
Bei einem Format wie dem Stramu, 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.
|
||||
|
||||
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.
|
||||
|
||||
## Validierung
|
||||
|
||||
Von [schema.org gibt es hier einen Online-Validator](https://validator.schema.org/).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue