Versionierte Publikation

pro4bib / handbuch-it-in-bibliotheken

Arbeitsversion des Handbuchs IT in Bibliotheken

https://it-in-bibliotheken.de/

Other

17 stars 16 forks source link

Versionierte Publikation #14

Open nichtich opened 2 years ago

nichtich commented 2 years ago

Bislang führ jede Änderungen im main branch indirekt zu einer Aktualisierung des Handbuchs. Sollten für ausgewählte Snapshots Versionen vergeben werden? Dies ist zumindest notwendig wenn wir eine DOI vergeben wollen. Ich denke folgender Workflow macht Sinn:

Vergabe von Versionsnummern für einzelne Ausgaben per git tag
Die letzte Versionsnummer sollte in den Metadaten beim Änderungsdatum stehen
Neue Versionsnummer führt dazu dass
- Snapshot (PDF oder gesamtes Repository?) via Zenodo mit DOI archiviert wird
- Snapshot der HTML-Seite beim Internet-Archive anlegegt wird
- Ein GitHub-Release angelegt wird (macht das Sinn?)
Zusätzliche Datei CHANGES.md mit wesentlichen Änderungen zwischen Ausgaben

jannabrechmacher commented 2 years ago

Der Workflow erscheint mir soweit plausibel. Ein paar Fragen habe ich dazu aber noch:

Wie unterscheiden sich die Ausgaben, die neue Versionsnummern bekommen, voneinander? Also, welcher Änderungsumfang führt zu einer neuen Version? Wird z.B. auch durch die Korrektur von Rechtschreibfehlern eine neue Version erzeugt oder erst bei einer Änderung wie z.B. bei der Zusammenführung von Styleguide.md und Contributing.md?
Erfolgt die Vergabe von git tag und der Metadaten sowie der changes.md automatisiert?

nichtich commented 2 years ago

Wann eine neue Ausgabe fertig ist müssen wir selber entscheiden und dann mit git tag eine entsprechende Versionsnummer vergeben und die changes.md anpassen. Für letztere reicht eine Stcihpunktliste z.B.

April 2022

Erster Book-Sprint
Juni 2022 Version X

Vorstellung auf dem Bibliothekskongress mit Kapiteln zu Management von IT-Systemen, Anforderungen an Bibliotheks-IT und Bibliotheksmanagementsysteme

nichtich commented 2 years ago

[ ] github action bei tagged commits
[ ] Archivieren im Internet Archive mit curl --verbose https://web.archive.org/save/it-in-bibliotheken.de.
[ ] Registrieren/Aktualisieren der DOI (#61)

nichtich commented 1 year ago

Statt/neben der Archivierung beim Internet Archive könnten wir auch selber einen Snapshot als WARC-Datei erstellen und bereitstellen und an geeigneter Stelle archivieren (DNB u.A.).