[docs] Create documentation to describe available tooling
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What is the Moodle feature that needs documenting?
This is partially already implemented in /docs/tools but it needs to move out of there.
I'd suggest it should be in /general/development/tools and have it's own navbar link perhaps.
We need to document:
- MDK - #54
- Our PHP code sniffs - #54
- moodle-plugin-ci
- Our official docker images
- grunt, eslint, stylelint, and friends
- CiBoT
We may also want to consider documenting the following under tools:
- PHPUnit
- Behat
Is this documentation specific to a Moodle version?
No
Are you able to provide a patch for this?
Yes - I will create one
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
Review the existing /docs/tools content and the proposed /general/development/tools location, including how documentation adds navbar links. Use the checklist to identify the remaining tools to document, and consider the optional PHPUnit and Behat entries; done means the relevant tooling has documented guidance in the new location and is discoverable from navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, eslint, javascript, php
- Domain
- devtools, documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100