Better documentation as what this does for a user
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 19
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 8
Description
The documentation on this item can use some love to help someone setup a controller.
Why would I use this and with what? What is the impact?
https://github.com/juju/juju-controller/blob/6b980132bc4c14a16e5d0618892f2f8b10589e1d/config.yaml#L5
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 with config.yaml at the linked line and review the surrounding documentation for the controller setup. Identify what a user needs to know about using this item, its purpose, and its impact; done means the documentation answers those questions clearly.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100