FAIR Cookbook - RDMkit
This repository will in the first place be used to link pages between FAIR Cookbook and RDMkit. These links are made and curated by the joint editorial board that exists between both teams.
Both websites have their content managed and deployed using GitHub:
- RDMkit: https://github.com/elixir-europe/rdmkit
- FAIR Cookbook: https://github.com/FAIRplus/the-fair-cookbook
What we do
To align visions and to keep track of content changes in both repositories we created a joint editorial board between FAIR Cookbook and RDMkit. This board meets every two months.
The core of our collaboration
Links between the two services are stored in the faircookbook_rdmkit_mapping.yml file. Changes made to this file will not immediately impact the websites. On a weekly basis FAIR Cookbook and RDMkit will pull changes from this central YAML file to update there repository. This is done using GitHub actions and is fully automatic. Any links towards FAIR Cookbook/RDMkit that were made manually will be overwritten by this process. In short: this repository holds the truth!
Contributing
Changes made to the faircookbook_rdmkit_mapping.yml file will be merged in the main branch using pull requests and only when at least one member of each editorial team has approved the changes. The main branch is for this reason protected against direct changes.
Mapping rules
- Data life cycle, your role, and national resources pages in RDMkit are not linked to FAIRCookbook recipes.
- Domain pages in RDMkit should only link to domain specific FAIR Cookbook recipes.
- Task pages in RDMkit should only link to FAIR Cookbook recipes for generic tasks.
GitHub Actions to increase sustainability
Because new content gets created over time in both resources, we created two automations in the repository to increase sustainability.
Automatic updating of the titles in the mapping file
Over time, page titles can change in both resources. We have thus put in place a system to keep displayed titles of linked pages in sync with the original resource. A GitHub Action will weekly check for title changes using information from the sidebars of RDMkit and FAIR Cookbook and create a pull request updating the titles in the main YAML file where needed.
Automatic issue creation when new content is added to one of the resources
Due to the changing nature of both resources, we will have to repeat the mapping exercise in the future. To make this job easier, we keep track of changes in both resources using GitHub issues which are opened automatically on this repository. Cache files in the cache branch are build using the sidebar files of both resources and store the content in the shape of title:url key-value pairs. If a new page or recipe gets added, an issue will be created describing this addition. This GitHub Action is run weekly. The cache branch should never be deleted!
