Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing help label description #82

Open
hhorak opened this issue Apr 12, 2017 · 2 comments
Open

Missing help label description #82

hhorak opened this issue Apr 12, 2017 · 2 comments

Comments

@hhorak
Copy link
Contributor

hhorak commented Apr 12, 2017

The help label is used by atomic, but is not documented in this repository. IMO it also caused the issue tracked in https://pagure.io/atomic-wg/issue/267, which was also reported to projectatomic/atomic#967.
Once the dilemma is resolved, we should document this label properly here.

@TomasTomecek
Copy link
Contributor

The current consensus is that help label should contain executable command. Tooling, such as atomic, should then interpret the command and display documentation to user.

@jmtd
Copy link
Contributor

jmtd commented Jul 12, 2018

That sounds like it is going to clash with https://github.com/projectatomic/container-best-practices/blob/master/creating/help.adoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants