oersi-datensatz/README.md
2024-10-16 13:55:00 +00:00

3.4 KiB

OERSI-Datensatz

Dieses Repository dient der Verwaltung und Bereitstellung von Metadaten zu Open Educational Resources (OER) im Rahmen des OERSI Systems. Alle Metadaten sind im Verzeichnis resource_metadata/ in YAML-Dateien abgelegt und werden zentral durch die Datei metadata.yml gebündelt. Diese Daten können durch den OERSI-Harvester gesammelt und verarbeitet werden, um OER-Ressourcen für eine größere Öffentlichkeit zugänglich zu machen.

Repository-Struktur

  • /resource_metadata/: Enthält alle YAML-Dateien mit den Metadaten zu den OER-Ressourcen.
  • /metadata.yml: Zentrale Datei, die mithilfe des !include-Statements alle YAML-Dateien im Verzeichnis resource_metadata/ einbindet.

Erste Schritte

1. Mitarbeit an den Metadaten

Um an den Metadaten mitzuwirken, kannst du entweder manuell Änderungen an den YAML-Dateien im Verzeichnis resource_metadata/ vornehmen oder den Prozess unterstützen, indem du hilfst, den Push von Metadaten aus dem Original-Repository (Forgejo) zu automatisieren.

Weitere Informationen zur GitLab-Konfiguration findest du in der offiziellen OERSI-Dokumentation.

2. Metadaten hinzufügen

  1. Füge im Verzeichnis resource_metadata/ eine neue YAML-Datei für jede OER-Ressource hinzu, die du bereitstellen möchtest. Beispiel:

    # resource_metadata/resource1.yml
    title: "Beispiel OER"
    description: "Eine Beschreibung der OER-Ressource"
    url: "https://example.com/resource1"
    license: "CC BY 4.0"
    

    Hierbei kann auch das OER Metadaten Formular helfen.

  2. Die Datei metadata.yml enthält bereits das !include-Statement, um alle YAML-Dateien im Verzeichnis resource_metadata/ zu bündeln:

    !include resource_metadata/*.yml
    

    Dies entspricht den Vorgaben der GitLab-Konfiguration für OERSI.

    Bereits umgesetzt:

    • Einbindung von Metadaten im YAML-Format mittels !include-Statement.
    • Bereitstellung der Metadaten in einem strukturierten Verzeichnis (resource_metadata/).

Nutzung

  • Die Metadaten werden von OERSI geharvestet und für die Öffentlichkeit zugänglich gemacht.
  • Stelle sicher, dass alle Metadaten den von OERSI geforderten Standards entsprechen, bevor du Änderungen einreichst.

Unterstützung

Bei Fragen oder Problemen wende dich bitte an das OERSI Team.

Beitragende

Beiträge zu diesem Projekt sind willkommen. Um mitzumachen, kannst du entweder manuell Änderungen an den YAML-Dateien vornehmen oder dabei helfen, den Push vom Original-Repository (Forgejo) zu automatisieren. Wir schätzen alle Beiträge, die die Qualität und den Umfang der OER-Datensätze verbessern.

Weitere Informationen zur Zusammenarbeit und Integration mit GitLab findest du in der OERSI-Dokumentation.

Lizenz

Dieses Projekt steht unter der CC BY 4.0 Lizenz. Weitere Informationen dazu findest du in der Datei LICENSE.

Projektstatus

Das Projekt wird aktiv weiterentwickelt. Neue Ressourcen und Beiträge sind immer willkommen, um den OERSI-Datensatz aktuell und umfassend zu halten.