Kurzbericht | 11. Mai 2023
Abschlussbericht Projekt: (Weiter-)Entwicklung der OpenSource-Software ConedaKOR
Von Dr. Anne Klammt
1. Übersicht Projekt
1.1 Zielsetzung
Im Rahmen des von NFDI4Culture, Aufgabenbereich 3 - Forschungswerkzeuge und Datendienste, geförderten Projekts wurden Maßnahmen zur besseren Nutzbarkeit und damit Nachhaltigkeit der OpenSource-Software ConedaKOR durchgeführt.
ConedaKOR ist eine ausgereifte quelloffene Forschungssoftware, die seit über zwölf Jahren im geisteswissenschaftlichen Forschungskontext eingesetzt und konstant weiterentwickelt wird. ConedaKOR leistet die Archivierung, Verwaltung und Recherche von Bild- und Metadaten auf einer gemeinsamen webbasierten Oberfläche. Entwickelt am Kunstgeschichtlichen Institut in Frankfurt in Main, wird ConedaKOR inzwischen in diversen Hochschulen und Forschungsinstitutionen eingesetzt. Bislang schränkte das Fehlen von leicht verständlichen Dokumentationen die Nutzung der Software für Anwender:innen sowie Systemadministrator:innen ein. Darüber hinaus fehlte es an einer niedrigschwelligen Installationsmöglichkeit.
Das Projekt hat die drei Desiderata mit vier Arbeitspaketen (AP) adressiert, die vollständig umgesetzt werden konnten.
AP 1: Tutorial-Videos (Zielgruppe: Anwender:innen, Administrator:innen, Entwickler:innen)
AP 2: Dokumentation I (Zielgruppe: Anwender:innen)
AP 3: Dokumentation II (Zielgruppe: Administrator:innen, Entwickler:innen)
AP 4: Containervirtualisierung von ConedaKOR mittels Docker
1.2 Zeitrahmen
Bewilligung: 20.04.2022
Durchführung: 01.05.2022 – 31.12.2022
1.3 Partner und Durchführende
Das Projekt wurde gemeinsam vom Leibniz-Institut für Europäische Geschichte Mainz (IEG) und dem Deutschen Forum für Kunstgeschichte Paris (DFK Paris) in Zusammenarbeit mit der Firma Wendig OU (Estland) durchgeführt. Die Projektleitung lag gemeinschaftlich bei Anne Klammt (DFK Paris) und Thorsten Wübbena (IEG). Für das DFK Paris hat Deborah Schlauch als wissenschaftliche Hilfskraft das Projekt unterstützt.
1.4 Fördersumme
Das Projekt wurde mit insgesamt 10.000 € gefördert. Davon sind 6.000 € an das IEG gegangen, welches damit die Durchführung der APs 3 und 4 verantwortlich durchgeführt hat und an den APs 1 und 2 beratend mitgearbeitet hat. Das DFK Paris hat 4.000 € erhalten und die APs 1 und 2 durchgeführt und bei den APs 3 und 4 beratend unterstützt.
1.5 Forschungsdatenmanagement
Alle im Vorhaben erstellten Produkte wurden gemäß den FAIR-Prinzipien frei zugänglich, offen lizenziert, dokumentiert und in nachnutzbarer Form in vertrauenswürdigen Repositorien veröffentlicht. Zusätzlich wurden die Produkte über Plattformen mit großer Reichweite (YouTube, GitHub) öffentlich bereitgestellt, um eine möglichst breite Nutzung zu erreichen. Die den Produkten zugrunde liegenden Daten werden zusätzlich im Archivspeicher des IEG archiviert, um eine Langzeitzugänglichkeit zu gewährleisten.
2. Arbeitspakete
2.1 Arbeitspaket 1: Tutorial-Videos
Insgesamt wurden fünf Videos angefertigt und über das AV-Portal der TIB Hannover, Youtube und die Webseite von ConedaKOR veröffentlicht. Die Videos wurden auf Englisch erstellt und auf YouTube zudem mit englischen Untertiteln versehen.
Drei der Videos richten sich an Anwender:innen und führen in die Installation mit Docker sowie die Nutzung der Software ein. Der Fokus liegt hierbei auf der Vorstellung ihrer wesentlichen Merkmale und ist mit Hinweisen auf die weiterführende Dokumentation verbunden.
Zwei weitere Videos richten sich an Systemadministrator:innen und Entwickler:innen, wobei eines detailliert in die Installation und Konfiguration von ConedaKOR einführt und das andere demonstriert, wie Daten aus einer ConedaKOR-Instanz via API-Nutzung in einem CMS (hier WordPress) genutzt werden können.
Produkte
Anwender:innen
- „Installation of ConedaKOR with Docker“ (04:28 min) TIB: https://doi.org/10.5446/60132 | YouTube: https://youtu.be/S7HrlhOMVkc
- Creating entity types, entities and relations in ConedaKOR“ (06:27 min) TIB: https://doi.org/10.5446/60133 | YouTube: https://youtu.be/vAR8FjORVzg
- „Creating fields and generators in ConedaKOR“ (05:10 min) TIB: https://doi.org/10.5446/60134 | YouTube: https://youtu.be/801feeJ3Zuc
Administrator:innen
- „How to install ConedaKOR on Debian 11 „bullseye““ (11:54 min) TIB: https://doi.org/10.5446/60135 | YouTube: https://youtu.be/ejQngJ2Zp-Y
Entwickler:innen
- „Writing a UI component with ConedaKOR as a backend“ (06:52 min) TIB: https://doi.org/10.5446/60136 | YouTube: https://youtu.be/0dWDk4LCl4I
2.2 Arbeitspaket 2: Dokumentation I (Zielgruppe: Anwender:innen)
Angelehnt an die Vorarbeiten des Leitfadens für die ConedaKOR-Instanz am Kunstgeschichtlichen Institut der Goethe-Universität Frankfurt wurde eine Dokumentation geschrieben, die generisch und losgelöst von der konkreten Implementierung ist. Die Dokumentation ist in drei Abschnitte gegliedert, die sich auf die Aufgaben und Bedarfe der Datenbank-Verantwortlichen, der Editor:innen und der Nutzer:innen beziehen. Die Dokumentation ist über GitHub veröffentlicht, was die zukünftige Pflege als „living document“ parallel zu weiteren Entwicklungen an ConedaKOR vereinfacht.
Produkt
- ConedaKOR documentation | Users, https://github.com/coneda/kor/blob/master/docs/user.md
2.3 Arbeitspaket 3: Dokumentation II (Zielgruppe: Administrator:innen, Entwickler:innen)
Auf Grundlage der bisherigen Readme-Datei für ConedaKOR auf GitHub wurde eine Dokumentation entwickelt, die generisch und losgelöst von der konkreten Implementierung ist. Die Dokumentation ist in zwei Teile gegliedert, die sich auf die Aufgaben und Bedarfe der Systemadministrator:innen und Entwickler:innen beziehen. Die Dokumentation ist über GitHub veröffentlicht, was die zukünftige Pflege als „living document“ parallel zu weiteren Entwicklungen an ConedaKOR vereinfacht.
Produkte
- ConedaKOR documentation | System administrators, https://github.com/coneda/kor/blob/master/docs/ops.md
- ConedaKOR documentation | Developers, https://github.com/coneda/kor/blob/master/docs/dev.md
2.4 Arbeitspaket 4: Containervirtualisierung von ConedaKOR mittels Docker
Ziel dieses APs war es, mittels Containervirtualisierung eine vereinfachte Installation von ConedaKOR zu ermöglichen. Genutzt wird in diesem Fall die Software „Docker“, für die – durch die Entwicklungsarbeit in AP 4 – nun Images erstellt werden können, die sämtliche Systembibliotheken, Skriptsprachen, Wörterbücher usw. enthalten, die es für den Prozess einer lauffähigen ConedaKOR-Instanz benötigt.
Produkt
- ConedaKOR documentation | Installation (Docker), https://github.com/coneda/kor/blob/master/docs/docker.md
Autoren: Anne Klammt (Deutsches Forum für Kunstgeschichte Paris | DFK Paris), Thorsten Wübbena (Leibniz-Institut für Europäische Geschichte, Mainz | IEG)