Can one of the admins verify that this patch is reasonable to test? (reply "ok to test", or if you trust the user, reply "add to whitelist")

If this message is too spammy, please complain to ixdy.

Thanks!

cc @kubernetes/kubectl

@RichieEscarez Please suggest where links to this should be added, or existing links to the generated docs should be changed to point here.

Labelling this PR as size/L

This is a good intro page. My only concern is that it will not stay up to date unless it's autogenerated. A good solution would be to modify gen_kubectl_docs.go to generate this doc, if you're interested in doing that. In particular the examples, operations, and resource types should be retrieved from the built kubectl. I'm also fine with submitting this as is (once appropriate links to/from existing kubectl docs are updated) and putting a note in #14177 to autogenerate this file.

Agree on auto-generate this doc. If we're submitting this as is please add kubectl edit too. https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/kubectl/kubectl_edit.md

@jlowdermilk thank you for reviewing this and giving these good suggestions. Yes this page is manually written and will be out of date if there is a change of kubectl. I have added the following line in this page:TODO: auto-generate this file to stay up with kubectl changes. Please see #14177.

Next step I will look into how to auto-generate it to stay up with kubectl's changes.

But please be noted that the examples in this page is expected to be oftenly used, small and stable, more user-friendly, rather than complete and exactly the same with kubectl, I rewrote these examples(not all of the commands have an example, not all of the examples given by a certain command are quoted, and I changed some variables, explanations etc).

@janetkuo thank you for the comment. I have added kubectl edit manually and will look into how to auto-generate this doc.

cc @alfred-huangjian

Sorry for the delay. Starting my review now.

After a discussion with @jlowdermilk, im going to LGTM this to make it live and then open a separate PR for my edits.

@k8s-bot ok to test

pr builder appears to be missing, activating due to 'lgtm' label.

Unit, integration and GCE e2e test build/test passed for commit 2ac0e15.

• Build Log
• Test Artifacts
• Internal Jenkins Results