Connecting GitLab/GitHub repos

Idea / Description

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

Provide metadata of the OER

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

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

GitLab configuration

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

GitHub configuration

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