uselagoon / uselagoon/lagoon-cli
Confusing docs
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.
Docs lack usage examples and lack links to related lagoon docs. There are many examples of different commands that do the same thing.
These 3 docs seem to cover the same operation but none say the difference between the 3 commands, which one should be used, no links to lagoon docs about project notifications, no examples of how to use:
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 the three linked command documentation pages and compare their descriptions, examples, and links. Clarify when each command should be used, add usage examples, and link the related Lagoon project-notification documentation; done means the overlap and differences are understandable from the docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100