[chore] Autogenerate the list of Dev docs contributors
Open
Nobody has claimed this yet.
help wanted
repo
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What do we need to do?
While reviewing https://github.com/moodle/devdocs/pull/87, Andrew raised this idea:
- We can auto-generate the user doc contributions using the Wikimedia API (https://docs.moodle.org/dev/Special:ApiSandbox#action=query&format=json&list=allusers&continue=-%7C%7C&aulimit=max&auwitheditsonly=1)
- We can also easily generate the list of Dev docs contributors with:
git shortlog -sn
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
Start by reviewing the linked Wikimedia API documentation and the existing Dev docs contributor workflow, then run git shortlog -sn to understand the repository-side source. Define how both the user documentation contributions and Dev docs contributors should be generated, and verify that the resulting lists are complete and reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100