Merge pull request #1580 from frodopwns/issue-1550-better-desc

WIP: Improve command descriptions

cmd/kops/create.go

@@ -7,7 +7,7 @@ import (
 // createCmd represents the create command
 var createCmd = &cobra.Command{
 	Use:   "create",
-	Short: "create resources",
+	Short: "Create a resource by filename or stdin.",
 	Long:  `Create resources`,
 }
 

cmd/kops/delete.go

@@ -7,8 +7,8 @@ import (
 // deleteCmd represents the delete command
 var deleteCmd = &cobra.Command{
 	Use:   "delete",
-	Short: "delete clusters",
+	Short: "Delete clusters and other resources.",
-	Long:  `Delete clusters`,
+	Long:  `Delete resources, such as clusters, instance groups, and secrets.'`,
 }
 
 func init() {

cmd/kops/describe.go

@@ -12,7 +12,7 @@ type DescribeCmd struct {
 var describeCmd = DescribeCmd{
 	cobraCommand: &cobra.Command{
 		Use:   "describe",
-		Short: "describe objects",
+		Short: "Get more information about cloud resources.",
 	},
 }
 

cmd/kops/edit.go

@@ -7,7 +7,7 @@ import (
 // editCmd represents the edit command
 var editCmd = &cobra.Command{
 	Use:   "edit",
-	Short: "edit items",
+	Short: "Edit clusters and other resrouces.",
 }
 
 func init() {

cmd/kops/export.go

@@ -7,7 +7,7 @@ import (
 // exportCmd represents the export command
 var exportCmd = &cobra.Command{
 	Use:   "export",
-	Short: "export clusters/kubecfg",
+	Short: "Exports a kubecfg for target cluster.",
 	Long:  `export clusters/kubecfg`,
 }
 

cmd/kops/get.go

@@ -15,7 +15,7 @@ var getCmd = GetCmd{
 	cobraCommand: &cobra.Command{
 		Use:        "get",
 		SuggestFor: []string{"list"},
-		Short:      "list or get objects",
+		Short:      "List all instances of a resource.",
 		Long:       `list or get objects`,
 	},
 }

cmd/kops/import.go

@@ -7,8 +7,8 @@ import (
 // importCmd represents the import command
 var importCmd = &cobra.Command{
 	Use:   "import",
-	Short: "import clusters",
+	Short: "Import existing resources into the state store.",
-	Long:  `import clusters`,
+	Long:  `Import existing resources, such as clusters into the state store.`,
 }
 
 func init() {

cmd/kops/rollingupdate.go

@@ -12,7 +12,7 @@ type RollingUpdateCmd struct {
 var rollingUpdateCommand = RollingUpdateCmd{
 	cobraCommand: &cobra.Command{
 		Use:   "rolling-update",
-		Short: "rolling update clusters",
+		Short: "Initiate rolling updates on clusters.",
 		Long:  `rolling update clusters`,
 	},
 }

cmd/kops/secrets.go

@@ -7,8 +7,8 @@ import (
 // secretsCmd represents the secrets command
 var secretsCmd = &cobra.Command{
 	Use:   "secrets",
-	Short: "Manage secrets & keys",
+	Short: "Manage secrets & keys.",
-	Long:  `Manage secrets & keys`,
+	Long:  `Manage secrets & keys.`,
 }
 
 func init() {

cmd/kops/toolbox.go

@@ -7,7 +7,7 @@ import (
 // toolboxCmd represents the toolbox command
 var toolboxCmd = &cobra.Command{
 	Use:   "toolbox",
-	Short: "Misc infrequently used commands",
+	Short: "Misc infrequently used commands.",
 }
 
 func init() {

cmd/kops/update.go

@@ -7,7 +7,7 @@ import (
 // updateCmd represents the create command
 var updateCmd = &cobra.Command{
 	Use:   "update",
-	Short: "update clusters",
+	Short: "Creates or updates cloud resources to match cluster spec.",
 	Long:  `Update clusters`,
 }
 

cmd/kops/upgrade.go

@@ -7,7 +7,7 @@ import (
 // upgradeCmd represents the upgrade command
 var upgradeCmd = &cobra.Command{
 	Use:   "upgrade",
-	Short: "upgrade clusters",
+	Short: "Automates checking for and applying Kubernetes updates.",
 	Long:  `upgrade clusters`,
 }
 

cmd/kops/version.go

@@ -13,7 +13,7 @@ type VersionCmd struct {
 var versionCmd = VersionCmd{
 	cobraCommand: &cobra.Command{
 		Use:   "version",
-		Short: "Print the client version information",
+		Short: "Print the client version information.",
 	},
 }