nextcloud / nextcloud/documentation
Easy citation of Nextcloud manuals
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 628
- Forks
- 2.5k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 135
Description
Github could help us ease the citation of our manuals for people who cite our docs in their scientific paper: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
Ref https://citation-file-format.github.io/ for the format
Challenges
- We have three manuals in one repo
- We can probably not list the real authors because
- Changes constantly and goes out of sync
- The list of authors would be very long
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read GitHub's citation-file guidance and the Citation File Format reference first. Inspect how the three manuals are organized in this repository, then decide what shared project metadata can represent them without a constantly outdated author list. Done means a valid citation file supports citing all three manuals and matches the chosen metadata.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100