Merge pull request #10993 from fabianofranz/451_cli_usability_improve…

…ments

Merged by openshift-bot

Makefile

@@ -70,6 +70,7 @@ verify: build
 	hack/verify-generated-clientsets.sh
 	hack/verify-generated-completions.sh
 	hack/verify-generated-docs.sh
+	hack/verify-cli-conventions.sh
 	PROTO_OPTIONAL=1 hack/verify-generated-protobuf.sh
 	hack/verify-generated-swagger-descriptions.sh
 	hack/verify-generated-swagger-spec.sh

docs/cli_hacking_guide.adoc

@@ -52,15 +52,17 @@ type MineOptions struct {
   mineLatest bool
 }
 
-const (
-  mineLong = `Some long description
-for my command.`
+var (
+  mineLong = templates.LongDesc(`
+    Some long description
+    for my command.`)
 
-  mineExample = `  # Run my command's first action
-  %[1]s first
+  mineExample = templates.Examples(`  
+    # Run my command's first action
+    %[1]s first
 
-  # Run my command's second action on latest stuff
-  %[1]s second --latest`
+    # Run my command's second action on latest stuff
+    %[1]s second --latest`)
 )
 
 // NewCmdMine implement the OpenShift cli mine command.
@@ -136,11 +138,12 @@ Example:
 ====
 [source,go,numbered,options="nowrap"]
 ----
-  deployExample = `  # Display the latest deployment for the 'database' deployment config
-  %[1]s database
+  deployExample = templates.Examples(`  
+    # Display the latest deployment for the 'database' deployment config
+    %[1]s database
 
-  # Start a new deployment based on the 'database' deployment config
-  %[1]s database --latest`
+    # Start a new deployment based on the 'database' deployment config
+    %[1]s database --latest`)
 ----
 ====
 
@@ -237,17 +240,19 @@ type DeployOptions struct {
   retryDeploy  bool
 }
 
-const (
+var (
   // 2.
-  deployLong = `Some long description 
-for the deploy command.` 
+  deployLong = templates.LongDesc(`
+    Some long description 
+    for the deploy command.`) 
 
   // 3.
-  deployExample = `  # Display the latest deployment for the 'database' DeploymentConfig
-  %[1]s database
+  deployExample = templates.Examples(`  
+    # Display the latest deployment for the 'database' DeploymentConfig
+    %[1]s database
 
-  # Start a new deployment based on the 'database' DeploymentConfig
-  %[1]s database --latest`
+    # Start a new deployment based on the 'database' DeploymentConfig
+    %[1]s database --latest`)
 )
 
 // 4.