How to integrate resources via GitLab / GitHub

How to integrate resources into the OERSI by providing the metadata on GitLab / GitHub
Tags:
Categories:

This guide describes the OERSI specific integration. Other SIDRE instances can also provide this feature, but need instance specific implementations for it. This is available for resodate (details will be added soon), cc, but sometimes requires slightly different forms or wording to take the different metadata into account.

Idea / Description

OER should be listed automatically in OERSI by specifying the metadata in GitLab or GitHub. The material can be in the same git repo or simply linked.

1. Create a GitLab or GitHub repo

You need a (free) GitLab or GitHub account for this.

You can also use an existing repo.

2. Provide metadata of the OER

  1. fill the form: https://oersi.gitlab.io/metadata-form/metadata-generator.html and press generate
  2. copy generated metadata (schema.org-properties) into a new file metadata.yml in the repo root directory
  3. Publish OER
    • set creativeWorkStatus to Published in your provided metadata.yml creativeWorkStatus: "Published"

2.1. (Optional) Metadata for multiple resources in a single repo

It is possible to specify a list of metadata records in metadata.yml instead of a single resource. Furthermore, metadata in metadata.yml can also be loaded from other Yaml files in the same repo. This works via the (non-standard Yaml) syntax !include <path/to/file.yml>. In GitLab repos, the wildcard character * can also be used in the file names to include several files at once (!include <path/to/*.yml>). This makes it possible to include a complete directory without having to adapt the metadata.yml for new resources.

Example multiple resources

metadata.yml:

- !include resource1.yml
- !include resource2.yml

Example multiple resources with wildcard in GitLab

metadata.yml:

!include resource_metadata/*.yml

3.a. Adjust GitLab configuration

  • Set topic Open Educational Resources in project settings
    • Settings -> General -> set Topics and Save changes

3.b. Adjust GitHub configuration

  • Set topic open-educational-resources
    • About (right side in the repo view) -> Settings -> set Topic