Dokumentation
Robert Koch-Institut | RKI
Nordufer 20
13353 Berlin
Hannes Wuensche
Pia Rissom
Fabian Eckelmann
MF4 | Informations- und Forschungsdatenmanagement
Wuensche, Hannes; Rissom, Pia; Eckelmann, Fabian (2022): OpenData-Website, Berlin: Zenodo. DOI:10.5281/zenodo.XXXXX.
Das GitHub Repository "OpenData-Website" ist lizenziert unter der MIT License.
Das RKI stellt in GitHub offene Datensätze zur Nachnutzung bereit. Für mit GitHub weniger vertraute Nutzer:innen stellt die Nutzung von GitHub jedoch teilweise eine Herausfoderung dar. Um diesen einen niederschwelligen Zugang zu den bereitgestellten Daten und Kontextinformationen zu bieten, haben wir auf Basis von GitHub-Actions ein Deployment von Datensatz eigenen Websites über GitHub-Pages entwickelt. Die Datensatz-Websites orientiert sich an der Cooperate Identity des RKI, ermöglicht das einfache Herunterladen von Daten und das schnelle erfassen der Datensatzdokumentation. Für die FAIRness der Nachnutzung werden ebenfalls Kernelement, wie Lizenz und Zitationsinformationen, angezeigt.
Das Repository stellt eine Action und den zugehörigen Quellcode für die Erzeugung und Veröffentlichung von Datensatz-Websites des RKIs bereit. Es handelt sich dabei um eine Angular-Website, welche als Datenbasis Daten und Metadaten ein Datensatz-Repositories nutzt. Die Website kommt somit ohne Backend aus und wird dadurch einfach wiederverwendbar.
Besteht Interesse die Datensatz-Website für eigene Datensätze, auf Basis des bereitgestellten Codes, zu nutzen, dann kontaktieren Sie uns unter opendata@rki.de oder via GitHub-Issues.
Für die erfolgreiche Erzeugung einer Datensatz-Website mit GitHub-Actions muss das zugrunde liegende Datensatz-Repository folgende Dateien, Metadaten und Struktur aufweisen:
- Das Repository muss "public" sein und die Daten frei zugänglich (Open Data)
- Es existiert ein Readme.md mit ausführlicher Dokumentation der Daten
- Es liegt eine zenodo.json Datei mit folgenden Metadaten vor:
- Namen des Datensatzes (zenodo.title)
- Datum der letzten Aktualisierung (zenodo.publication_date)
- Autor:innen (zenodo.creators)
- Beitragende (zenodo.contributors)
- Kurze Beschreibung/Abstract der Datenquelle und Daten (zenodod.descriptions)
- Schlagwörter (zenodo.keywords)
- Es ist eine Lizenz-Datei in dem Repository hinterlegt (z.b CC-BY)
- In den GitHub Metadaten (Feld: "Webseite") des Repositories ist eine Zenodo DOI hinterlegt.
Die Datei- und Ordnerstruktur des Datensatz-Repositories wird auf der Datensatz-Website ebenfalls abgebildet. Es wird daher empfohlen die Ordnerstruktur übersichtlich zu halten und die relevanten Daten möglichst im Root-Verzeichnis (oberstes Verzeichnisebene) abzulegen.
Für das Deployment der Datensatz-Website zwei GitHub-Actions zentral, beide sind im vorliegenden Repository enthalten.
Im Unterordner /createDatasourceJsonAction/ befindest sich die Action "Create datasource.json", die mittels der Github-API alle für die Website benötigten Daten zusammenträgt und in eine JSON-Datei schreibt (./src/app/data/datasource.json).
Über die im Root-Verzeichnis enthaltene action.yml stellt das Repository selbst die aufrufbare Action "Bulid and deploy Opendata-Website" dar. Die action.yml enthält alle Schritte, um die Datensatz-Website für eigene Datensatz-Repositories zu bauen und deployen. Die Action "Create datasource.json" ist dabei ein Teilschritt des Workflows der Action "Bulid and deploy Opendata-Website".
Damit die Action erfolgreich ausgeführt werden kann, müssen die oben genannten Voraussetzungen erfüllt sein.
Die Action "Create datasource.json" ist für das Erstellen der datasource.json (/src/app/data/datasource.json) verantwortlich und wird im Workflow der Action "Bulid and deploy Opendata-Website" aufgerufen. Der Quellcode der Action befindet sich in /src/github-action. Folgende Schritte werden durch die Action ausgeführt:
- Authentifizierung an GitHub-API mittels GH_TOKEN
- Abfragen des Datensatz-Repositories, aus dem heraus die Action aufgerufen wurde
- Hinzufügen des externen Zenodo-Links, sofern Zenodo-DOI in Website eingetragen ist
- Abfragen der Dateien des Datensatz-Repositories
- Parsen und Einlesen der zenodo.json um die in Voraussetzungen beschriebenen Metadaten zu extrahieren
- Einlesen der Dokumentation aus der Readme.md
- Lizenz auslesen
- Schreiben der datasource.json nach
./src/app/data/datasource.json
Auf Basis der action.yml erzeugt und deployed die Action "Bulid and deploy Opendata-Website" eine Datensatz Website des aufrufenden Datensatz-Repositories. Die Action führt dazu vier Schritte aus, die in der action.yml definiert sind:
- Pullen es "OpenData-Website"-Repositories
- Erzeugen der datasource.json
- Installation Node.js
- Build und Deploy der Opendata-Website (nutzt angular-cli-ghpages)
Für die Ausführung der Actions müssen folgende Informationen als Input übergeben werden:
inputs:
GH_TOKEN:
description: "GitHub token"
default: $
required: true
WEBSITE_BRANCH:
description: "Branch to deploy the website"
default: "opendata-website"
required: false| Input | Required | Default | Beschreibung |
|---|---|---|---|
| GH_TOKEN | true | $ | Ein GitHub Token, welches Zugriff auf das Repository hat. Dieses wird benötigt, um die datasource.json über die GitHub-API zu erzeugen. |
| WEBSITE_BRANCH | false | "opendata-website" | Der Name des Branchs, in den die Website deployt wird. |
Zwei Schritte sind für die Implementierung innerhalb eines Datensatz-Repositories nötig:
- Anlegen eines Workflows im Ordner
.github/workflows/der die Action aufruft - Festlegung des Source Branches in den Einstellungen des Datensatz-Repositories für die GitHub Pages
Um die Action "OpenData-Website" in einem eigenen Datensatz-Repository zu nutzen muss folgender Schritt in einem GitHub-Workflow deklariert werden.
- name: Create and deploy opendata website
uses: robert-koch-institut/OpenData-Website@main
with:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
WEBSITE_BRANCH: "opendata-website"GitHub-Workflows werden im .github/workflows/ abgelegt. Ein Beispiel für einen Workflow, der einen Datensatz-Website in einem Datensatz-Repository erzeugt, ist in der implementation_example.yml bereitgestellt. Weiterführende Informationen zu Workflows und Actions können der GitHub-Dokumentation entnommen werden.
Nach erfolgreichem Ausführen der Action "OpenData-Website" ist im Datensatz-Repository eine neuer Branch opendata-website (deflaut) angelegt. Um die darin gebaute Website über GitHub-Pages anzeigen zu lassen muss unter
Settings > Pages > Source
Der Branch opendata-website für das Pages-Deployment ausgewählt und gespeichert werden. Im oberen Bereich der Settings wird dann der Link zur Datensatz-Website angezeigt.
Die Website ist in Angular 12 geschrieben und wird mittels der Action OpenData-Website transpiliert und innerhalb des GitHub Datensatz-Repositories in einen eigenen Branch (siehe Inputs) gepusht. Der Branch wird von der Action eigenständig angelegt und es bedarf keiner weiteren Vorbereitung des Datensatz-Repository. Für das Deployment der Website durch GitHub-Pages muss in den Einstellungen der entsprechende Branch ausgewählt werden.
Die Website benötigt kein Backend, da die genutzten Daten mittels der Action createDatasourceJsonAction erzeugt werden. Im folgenden wird kurz die Datenstruktur der datasource.json beschrieben.
Alle Daten der Website sind in der /app/data/datasource.json gespeichert. Diese wird mit Hilfe der Action "Create datasource.json" erzeugt und hat folgende Struktur:
export interface OpenDataDatasource {
id: string;
branch: string;
name: string;
description: string;
licence: string;
tags: string[];
doi: string;
lastUpdated: Date;
contributors: { name: string; role: string }[];
authors: string[];
externalLinks: ExternalLink[];
readme: string;
content: DatasourceContent[];
}
export interface ExternalLink {
$type: 'github' | 'zenodo';
url: string;
}
export interface Contributor {
name: string;
role: string;
}
export interface FileDatasourceContent {
$type: 'file';
name: string;
path: string;
previewUrl: string;
downloadUrl: string;
visitUrl: string;
lfs: boolean;
}
export interface FolderDatasourceContent {
$type: 'folder';
name: string;
path: string;
content: DatasourceContent[];
}
export type DatasourceContent = FileDatasourceContent | FolderDatasourceContent;