Add single resources

Please check first whether your resources & metadata meet the criteria for inclusion in OERSI.

Manual listing in an already indexed collection

One option is to include your OER in one of the collections that is already indexed in OERSI.

List your OER on GitLab.com or GitHub

OER will be listed automatically in OERSI when 1.) the metadata is specified and 2.) the tag open-educational-resources is added to a GitLab or GitHub repository. The educational material can be in the same repo as the metadata or simply linked.

Provide metadata of the OER

• Describe the material
• 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 / GitHub repo configuration

• Set topic open-educational-resources in project settings
  • GitLab: Settings -> General -> set Topics and Save changes
    • Note: for GitLab, the deprecated topic Open Educational Resources is still supported
  • GitHub: About (right side in the repo view) -> Settings -> set Topic