Add examples for kubectl describe, and make gendocs less spammy

Makes hack/{run/verify}-gendocs.sh ignore generated-timestamp-only
changes so minor changes to kubectl don't have to touch the entire
set of md docs.
This commit is contained in:
Jeff Lowdermilk
2015-04-23 14:21:13 -07:00
parent bb478a9e21
commit a8e2f6e9c8
6 changed files with 54 additions and 24 deletions

View File

@@ -29,12 +29,17 @@ import (
func NewCmdDescribe(f *cmdutil.Factory, out io.Writer) *cobra.Command {
cmd := &cobra.Command{
Use: "describe RESOURCE ID",
Use: "describe (RESOURCE NAME | RESOURCE/NAME)",
Short: "Show details of a specific resource",
Long: `Show details of a specific resource.
This command joins many API calls together to form a detailed description of a
given resource.`,
Example: `// Describe a node
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
// Describe a pod
$ kubectl describe pods/nginx`,
Run: func(cmd *cobra.Command, args []string) {
err := RunDescribe(f, out, cmd, args)
cmdutil.CheckErr(err)