Loading
Draft: Add citation support for repositories
- Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you receive complimentary access to GitLab Duo.
What does this MR do and why?
- Resolves #337368
- In this MR we aim to implement basic support for rendering software citation metadata from
CITATION.cfffiles in the Citation File Format (DFF) present in the repository. - This should be similar to what GitHub does (see #337368 for details).
- Implementation plan:
- Add a link to the repository landing page when a
CITATION.cfffile is detected. - Upon clicking the link, go to the file page for the
CITATION.cfffile - Add a header providing basic documentation about what user is looking at as well as copy-and-pastable citation strings
- Citation strings are rendered from contents of CFF file via the
ruby-cffgem (which is also what GitHub uses)
- Add a link to the repository landing page when a
References
See above
Screenshots or screen recordings
| Before | After |
|---|---|
How to set up and validate locally
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Related to #337368
Edited by 🤖 GitLab Bot 🤖