equinix-labs / equinix-labs/otel-cli
document --verbose --fail pattern better
Open
- Dominant language
- Go
- Stars
- 716
- Forks
- 57
- PR merge metrics
- No merged PRs in 30d
Description
Ever since switching otel-cli to default to silent failure, it is tricky even for me to remember I have to send the --verbose --fail flags to get it to output the error and fail as expected. This should at least be clearer in the README.
Contributor guide
Research direction
Start in the repository README and locate the usage guidance for --verbose and --fail. Explain that otel-cli defaults to silent failure and document that both flags are needed to print errors and fail as expected; done when the README makes this behavior clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100