galaxyproject / galaxyproject/training-material

Update Contributor metadata

Open
#5,509 1 comment 0 reactions 0 assignees View on GitHub
CoFest help-wanted newcomer-friendly
Dominant language
HTML
Stars
367
Forks
1.1k
Avg merge
16h 27m
Merged PRs (30d)
49

Description

We support a Contribution Annotation Framework that allows us to indicate roles of conributors. However, many tutorials still use the "old" style contribution metadata (without roles)

Updating this involves rewriting old-style `contributors` metadata to new-style `contributions` metadata (see [FAQ](https://training.galaxyproject.org/training-material/topics/contributing/faqs/new-contributions.html)), with any contributors being given the author role.

![image](https://github.com/user-attachments/assets/3e24ca20-3f77-45e4-a737-abf81492b7df)

Depending on your skillset, this could be done manually, or via a script to do a bulk find and replace.

Contributor guide

Open the contributing guide

Research direction

Start with the linked FAQ to understand the new Contribution Annotation Framework, then search the repository for old-style `contributors` metadata. Rewrite each occurrence using `contributions` with the author role, and verify that no old-style metadata remains and the tutorials still render correctly.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.