-
Notifications
You must be signed in to change notification settings - Fork 40k
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
Document kubectl syntax/usage/output conventions #6797
Comments
Another thing that we had discussed:
|
+1. In theory it could be expanded to cli-conventions.md, though I think kubectl operates quite differently than most of our other daemons. But it still may be wise for it to cover other command-line tools besides kubectl, like simplegen, podex, etc. |
VERB and VERB NOUN, not NOUN VERB. We may need to reconsider kubectl config. |
That being said, if you have sets of functionality that are distinct, sometimes it's nice to keep them separate (treat kubectl config like kubectl-config).
|
Also output conventions: #7843 (comment) |
More output conventions: #3894 (comment) |
More output conventions: #8476 |
Only use templates when writing reusable scripts. Human output formats may change. |
Errors output to stderr rather than (or in addition to) glog: #9357 |
cc @janetkuo |
More output conventions:
|
We also want conventions for:
All of these should be orthogonal to output format (default, wide, json, yaml, template). |
I'm thinking of something like api-conventions.md, but for kubectl. It should at least cover the general command patterns, common arguments, and typical output.
Example topics to cover:
If not too long, the overall kubectl.md could be a reasonable place to put the text.
cc @smarterclayton @jlowdermilk @ghodss
The text was updated successfully, but these errors were encountered: