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

Add kubectl overview page #14177

Merged

Conversation

hw-qiaolei
Copy link
Contributor

@hw-qiaolei hw-qiaolei commented Sep 18, 2015

This is an effort try to fix: #11814

@bgrant0607 @hurf

@k8s-bot
Copy link

@k8s-bot k8s-bot commented Sep 18, 2015

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.

@hw-qiaolei hw-qiaolei force-pushed the add_kubectl_overview_page branch from 56e2a44 to c568a3d Compare Sep 18, 2015
@bgrant0607
Copy link
Member

@bgrant0607 bgrant0607 commented Sep 18, 2015

Thanks!

cc @kubernetes/kubectl

@bgrant0607
Copy link
Member

@bgrant0607 bgrant0607 commented Sep 18, 2015

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

@k8s-github-robot k8s-github-robot added the size/L label Sep 18, 2015
@k8s-github-robot
Copy link
Contributor

@k8s-github-robot k8s-github-robot commented Sep 18, 2015

Labelling this PR as size/L


## Common Operations

For explanation, here I gave some mostly often used `kubectl` command examples. Please replace sample names with actually values if you would like to try these commands.
Copy link
Contributor

@j3ffml j3ffml Sep 18, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/actually/actual

@j3ffml
Copy link
Contributor

@j3ffml j3ffml commented Sep 18, 2015

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.

@janetkuo
Copy link
Member

@janetkuo janetkuo commented Sep 18, 2015

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

@hw-qiaolei
Copy link
Contributor Author

@hw-qiaolei hw-qiaolei commented Sep 19, 2015

@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).

@hw-qiaolei
Copy link
Contributor Author

@hw-qiaolei hw-qiaolei commented Sep 19, 2015

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

@hw-qiaolei
Copy link
Contributor Author

@hw-qiaolei hw-qiaolei commented Sep 19, 2015

cc @alfred-huangjian

@hw-qiaolei hw-qiaolei force-pushed the add_kubectl_overview_page branch 2 times, most recently from f455135 to 2ac0e15 Compare Sep 19, 2015
@RichieEscarez
Copy link
Contributor

@RichieEscarez RichieEscarez commented Sep 29, 2015

Sorry for the delay. Starting my review now.

@RichieEscarez RichieEscarez added the lgtm label Sep 29, 2015
@RichieEscarez
Copy link
Contributor

@RichieEscarez RichieEscarez commented Sep 29, 2015

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

@k8s-github-robot
Copy link
Contributor

@k8s-github-robot k8s-github-robot commented Sep 29, 2015

@k8s-bot ok to test

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

@k8s-bot
Copy link

@k8s-bot k8s-bot commented Sep 29, 2015

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

brendandburns added a commit that referenced this issue Sep 30, 2015
@brendandburns brendandburns merged commit 7ef257d into kubernetes:master Sep 30, 2015
4 checks passed
@alfred-huangjian alfred-huangjian deleted the add_kubectl_overview_page branch Sep 30, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/kubectl lgtm size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants