uselagoon / uselagoon/lagoon-cli
Documentation by Object
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 28
- Forks
- 14
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
I often what to know what objects I can operate on, and what I can do to them
Describe the solution you'd like
If the docs had a page for each object (eg, "project", "user"), and listed:
- The commands for directly operating on them (eg. lagoon add project)
- The commands that link them to things (eg. lagoon add project-group)
...that'd be great.
Each command should just have a short description (ie. one line), and link to the main command page
Describe alternatives you've considered
Digging through the docs like I do now.
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 existing CLI documentation and its command pages to identify the objects and commands already documented. Add an object-focused page for each relevant object, listing direct and linking commands with one-line descriptions and links to the main command pages; done means users can find those operations without searching through the docs.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100