carvel-dev / carvel-dev/carvel

Document CLI UI guidelines

Open
#152 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
408
Forks
148
PR merge metrics
No merged PRs in 30d

Description

@aaronshurley commented on [Tue Mar 02 2021](https://github.com/vmware-tanzu/carvel-community/issues/19)

Flag guidelines:
- `--dangerous-*`
- `--*-alpha`

Examples of current inconsistencies:

- running `kapp` produces help msg and error
- vendir and imgpkg on the other hand just produce error message with list of sub commands
- ytt and kbld return successfully (since they have root commands registered)

_Note: This issue originated from https://github.com/k14s/design-docs/issues/2 but has been moved here as a part of the carvel rename._

Contributor guide

Open the contributing guide

Research direction

Compare the documented command-line behavior of kapp, vendir, imgpkg, ytt, and kbld, starting with their help and error output. Define consistent guidelines for flags such as --dangerous-* and --*-alpha and for root-command behavior, then document the agreed conventions.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.