How to make OER in Helmholtz Codebase discoverable by OERSI¶
About OER¶
What is OER¶
Open Educational Ressources include all kind of media intended to transport knowledge available under an OER-compatible license like CC-BY. This could be websites, presentations, video tutorials, course material, worksheets and many more.
What is OERSI¶
The OER Serach Index is a platform that collects various OER offers from different platforms and makes them discoverable by listing them along with their metadata and related information on their page where learners can search for material matching their topic of interest.
OERSI queries various hosting platforms for sources marked as OER, such as university libraries, GitLab / GitHub and also (since January 2023) the Helmholtz Codebase.
Steps to make your OER discoverable¶
This assumes you have a repository on the Helmholtz Codebase containing the OER you want to publish.
- Create a YAML-file containing the required metadata. The OERSI provides a very helpful online generator that can do this for you.
- Note that the URL field is the URL that points to the final ressources to be shared, not the repository the material comes from.
- Copy the generated
metadata.yml
into the root folder of your repository. - Go into the project settings and under General add the topic
Open Educational Ressources
. - Make sure the projects’ visibility is set to public.
- When you want your work to be shared also ensure that in the
metadata.yml
the value forcreativeWorkStatus
is set toPublished
.
Now the magic happens on its own and OERSI will discover your work automatically within a day. You can change / update your metadata at any time in case of changes.
Example Project¶
In case you would like to see an example, you can take a look at our OOP in Python course, especially the metadata.yml
file.
Notice the settings of the topic as shown below: