openwisp / openwisp/openwisp-docs
[improvement] Custom command documentation
Open
Nobody has claimed this yet.
Docs
- Dominant language
- Python
- Stars
- 59
- Forks
- 73
- Avg merge
- 1h 1m
- Merged PRs (30d)
- 1
Description
Currently there is 3 part of the documentation about custom commands:
- https://openwisp.io/docs/dev/controller/user/shell-commands.html#defining-new-options-in-the-commands-menu
- https://openwisp.io/docs/dev/controller/developer/utils.html#registering-unregistering-commands
- https://openwisp.io/docs/dev/controller/user/settings.html#openwisp-controller-user-commands
Second is linked to the third and third to the first, but no reference in the first.
Maybe a Note with a link should be added in the first one.
Contributor guide
No contributing guide indexed for this repository
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 with the custom commands documentation at shell-commands.html#defining-new-options-in-the-commands-menu, then compare its links with the related settings.html and developer/utils.html sections. Confirm the cross-references are complete and verify the rendered documentation shows the added reference.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100