cmd: improve help wording for ECE specific commands (#169)

Adds "(for ECE installations only)" to the descriptions of the commands which are ECE-specific.

In order to avoid complexity and still provide a good UX, the best course of action is to let the users know which commands will only work in ECE through the --help flag, and the documentation. Users will receive a 401 error if they attempt to run this command.

Author: karencfv

cmd/platform/allocator/command.go

@@ -26,7 +26,7 @@ import (
 // Command represents the allocator command
 var Command = &cobra.Command{
 	Use:     "allocator",
-	Short:   "Manages allocators",
+	Short:   "Manages allocators (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/constructor/command.go

@@ -36,7 +36,7 @@ const (
 // Command represents the constructor command
 var Command = &cobra.Command{
 	Use:     "constructor",
-	Short:   "Manages constructors",
+	Short:   "Manages constructors (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/enrollment-token/command.go

@@ -35,7 +35,7 @@ const (
 // Command represents the enrollment-token subcomand.
 var Command = &cobra.Command{
 	Use:     "enrollment-token",
-	Short:   "Manages tokens",
+	Short:   "Manages tokens (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/instance-configuration/command.go

@@ -32,7 +32,7 @@ import (
 // Command is the top instance-config subcommand.
 var Command = &cobra.Command{
 	Use:     "instance-configuration",
-	Short:   "Manages instance configurations",
+	Short:   "Manages instance configurations (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run:     func(cmd *cobra.Command, args []string) { cmd.Help() },
 }

cmd/platform/platform.go

@@ -46,7 +46,7 @@ var Command = &cobra.Command{
 
 var infoCmd = &cobra.Command{
 	Use:     "info",
-	Short:   "Shows information about the platform",
+	Short:   "Shows information about the platform (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		p, err := platform.GetInfo(platform.GetInfoParams{

cmd/platform/proxy/command.go

@@ -35,7 +35,7 @@ const (
 // Command represents the proxy command
 var Command = &cobra.Command{
 	Use:     "proxy",
-	Short:   "Manages proxies",
+	Short:   "Manages proxies (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/repository/command.go

@@ -32,7 +32,7 @@ import (
 )
 
 const (
-	snapshotShortHelp       = "Manages snapshot repositories"
+	snapshotShortHelp       = "Manages snapshot repositories (for ECE installations only)"
 	snapshotCreateShortHelp = "Creates / updates a snapshot repository"
 )
 

cmd/platform/role/command.go

@@ -24,7 +24,7 @@ import (
 // Command is the top level role command.
 var Command = &cobra.Command{
 	Use:     "role",
-	Short:   "Manages platform roles",
+	Short:   "Manages platform roles (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/runner/command.go

@@ -24,7 +24,7 @@ import (
 // Command is the top level runner command.
 var Command = &cobra.Command{
 	Use:     "runner",
-	Short:   "Manages platform runners",
+	Short:   "Manages platform runners (for ECE installations only)",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/stack/command.go

@@ -76,7 +76,7 @@ func listStackPacks(cmd *cobra.Command, args []string) error {
 
 var stackUploadCmd = &cobra.Command{
 	Use:     "upload",
-	Short:   "Uploads an Elastic StackPack",
+	Short:   "Uploads an Elastic StackPack (for ECE installations only)",
 	PreRunE: cobra.MinimumNArgs(1),
 
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -95,7 +95,7 @@ var stackUploadCmd = &cobra.Command{
 
 var stackDeleteCmd = &cobra.Command{
 	Use:     "delete",
-	Short:   "Deletes an Elastic StackPack",
+	Short:   "Deletes an Elastic StackPack (for ECE installations only)",
 	PreRunE: cobra.MinimumNArgs(1),
 
 	RunE: func(cmd *cobra.Command, args []string) error {