Better documentation as what this does for a user

Open
#36 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

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.

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

Dominant language
Python
Stars
3
Forks
21
Avg merge
2d 22h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from juju/juju-controller

All issues in juju/juju-controller

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.