Merge pull request #906 from SoftLayer/issues901

Updated vs upgrade help message

Author: allmightyspiff

README.md

@@ -344,11 +344,9 @@ func NewActionNameCommand(sl *metadata.SoftlayerCommand) *ActionNameCommand {
         Use: "command-name",
         Short: T("A description of the command"),
         Long: T(`This is an optional field, you can remove it if the command is simple.
-Otherwise create a nice long description of how to use this command. Its good to add some examples.
-
-EXAMPLE:
-    ${COMMAND_NAME} sl newcommand command-name --someFlag test --soomethingElse
-    This sets a flag and does something else.`)
+Otherwise create a nice long description of how to use this command. Its good to add some examples.`),
+        Example: fmt.Sprintf(`${COMMAND_NAME} sl newcommand command-name --someFlag test --soomethingElse
+    %s`, T(`This sets a flag and does something else.`)),
         Args: metadata.NoArgs,
         RunE: func(cmd *cobra.Command, args []string) error {
             return thisCmd.Run(args)
@@ -544,6 +542,23 @@ It("return error", func() {
 })
 ```
 
+## Adding Examples
+
+Use the CobraCLI Example property when possible. `vs upgrade` for an example:
+
+```go
+    cobraCmd := &cobra.Command{
+        Use:   "upgrade " + T("IDENTIFIER"),
+        Short: T("Upgrade a virtual server instance"),
+        Long: T(`Note: This virtual server will be rebooted once the upgrade order is placed.
+The instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.`) + `
+` + T(`The -c and -m options are for dedicated VSI upgrade, most VSIs will need to upgrade with --flavor.
+See '${COMMAND_NAME} sl vs options' for flavor keyNames to use.`),
+        Example: `${COMMAND_NAME} sl vs upgrade 12345678 --flavor B1_8X32X25`,
+```
+
+This helps make the strings a bit easier to translate.
+
 
 # Plugin Support / Release Process
 After v1.4.1 `sl` will be a normal plugin, so where are the instructions to build the plugin. 

plugin/commands/virtual/upgrade.go

@@ -36,11 +36,10 @@ func NewUpgradeCommand(sl *metadata.SoftlayerCommand) (cmd *UpgradeCommand) {
 		Use:   "upgrade " + T("IDENTIFIER"),
 		Short: T("Upgrade a virtual server instance"),
 		Long: T(`Note: This virtual server will be rebooted once the upgrade order is placed.
-The instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.
-
-EXAMPLE:
-	${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000
-	This commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.`),
+The instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.`) + `
+` + T(`The -c and -m options are for dedicated VSI upgrade, most VSIs will need to upgrade with --flavor.
+See '${COMMAND_NAME} sl vs options' for flavor keyNames to use.`),
+		Example: `${COMMAND_NAME} sl vs upgrade 12345678 --flavor B1_8X32X25`,
 		Args: metadata.OneArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return thisCmd.Run(args)

plugin/commands/virtual/virtual.go

@@ -19,7 +19,6 @@ func SetupCobraCommands(sl *metadata.SoftlayerCommand) *cobra.Command {
 	cobraCmd := &cobra.Command{
 		Use:   "vs",
 		Short: T("Classic infrastructure Virtual Servers"),
-		Long:  "${COMMAND_NAME} sl vs",
 		RunE:  nil,
 	}
 	cobraCmd.AddCommand(NewAuthorizeStorageCommand(sl).Command)

plugin/i18n/v2Resources/active.de_DE.json

@@ -4691,8 +4691,8 @@
   "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC": {
     "other": "Hinweis: Mehr als 6.000 IOPS sind nur verfügbar in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC"
   },
-  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.": {
-    "other": "Anmerkung: Dieser virtuelle Server wird erneut gestartet, sobald die Upgradeauftrag erteilt wurde.\nDie Instanz wird angehalten, bis die Upgradetransaktion abgeschlossen wurde. Für das Netz ist jedoch kein Warmstart erforderlich.\n\nBEISPIEL:\n ${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 -- network 1000\n Dieser Befehl führt ein Upgrade der virtuellen Serverinstanz mit der ID 12345678 durch und setzt die Anzahl der CPU-Kerne auf 8, den Speicher auf 8192M und die Geschwindigkeit des Netzports auf 1000 Mb/s."
+  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.": {
+    "other": "Anmerkung: Dieser virtuelle Server wird erneut gestartet, sobald die Upgradeauftrag erteilt wurde.\nDie Instanz wird angehalten, bis die Upgradetransaktion abgeschlossen wurde. Für das Netz ist jedoch kein Warmstart erforderlich."
   },
   "Notes": {
     "other": "Anmerkungen"

plugin/i18n/v2Resources/active.en-US.json

@@ -308,15 +308,9 @@
   "${COMMAND_NAME} sl vlan create [OPTIONS]\n\t\nEXAMPLE:\n   ${COMMAND_NAME} sl vlan create -t public -d dal09 -n myvlan\n   This command creates a public vlan located in datacenter dal09 named \"myvlan\".\n   ${COMMAND_NAME} sl vlan create -r bcr01a.dal09 -n myvlan\n   This command creates a vlan on router bcr01a.dal09 named \"myvlan\".": {
     "other": "${COMMAND_NAME} sl vlan create [OPTIONS]\n\t\nEXAMPLE:\n   ${COMMAND_NAME} sl vlan create -t public -d dal09 -n myvlan\n   This command creates a public vlan located in datacenter dal09 named \"myvlan\".\n   ${COMMAND_NAME} sl vlan create -r bcr01a.dal09 -n myvlan\n   This command creates a vlan on router bcr01a.dal09 named \"myvlan\"."
   },
-  "EXAMPLE:\n   ${COMMAND_NAME} sl vlan detail 12345678\t--no-vs --no-hardware\n   This command shows details of vlan with ID 12345678, and not list virtual server or hardware server.": {
-    "other": "EXAMPLE:\n   ${COMMAND_NAME} sl vlan detail 12345678\t--no-vs --no-hardware\n   This command shows details of vlan with ID 12345678, and not list virtual server or hardware server."
-  },
   "${COMMAND_NAME} sl vlan edit IDENTIFIER [OPTIONS]\n\t\nEXAMPLE:\n   ${COMMAND_NAME} sl vlan edit 12345678 -n myvlan-rename\n   This command updates vlan with ID 12345678 and gives it a new name \"myvlan-rename\".": {
     "other": "${COMMAND_NAME} sl vlan edit IDENTIFIER [OPTIONS]\n\t\nEXAMPLE:\n   ${COMMAND_NAME} sl vlan edit 12345678 -n myvlan-rename\n   This command updates vlan with ID 12345678 and gives it a new name \"myvlan-rename\"."
   },
-  "EXAMPLE:\n   ${COMMAND_NAME} sl vlan list -d dal09 --sortby number\n   This commands lists all vlans on current account filtering by datacenter equals to dal09, and sort them by vlan number.\n \nNote: In field Pod, if add (*) indicated that closed soon": {
-    "other": "EXAMPLE:\n   ${COMMAND_NAME} sl vlan list -d dal09 --sortby number\n   This commands lists all vlans on current account filtering by datacenter equals to dal09, and sort them by vlan number.\n \nNote: In field Pod, if add (*) indicated that closed soon"
-  },
   "${COMMAND_NAME} sl vs authorize-storage [OPTIONS] IDENTIFIER\n\nEXAMPLE:\n   ${COMMAND_NAME} sl vs authorize-storage --username-storage SL01SL30-37 1234567\n   Authorize File, Block and Portable Storage to a Virtual Server.": {
     "other": "${COMMAND_NAME} sl vs authorize-storage [OPTIONS] IDENTIFIER\n\nEXAMPLE:\n   ${COMMAND_NAME} sl vs authorize-storage --username-storage SL01SL30-37 1234567\n   Authorize File, Block and Portable Storage to a Virtual Server."
   },
@@ -1883,6 +1877,12 @@
   "EXAMPLE:\n\t${COMMAND_NAME} sl tags set --tags 'tag1,tag2' --key-name HARDWARE --resource-id 123456\n": {
     "other": "EXAMPLE:\n\t${COMMAND_NAME} sl tags set --tags 'tag1,tag2' --key-name HARDWARE --resource-id 123456\n"
   },
+  "EXAMPLE:\n   ${COMMAND_NAME} sl vlan detail 12345678\t--no-vs --no-hardware\n   This command shows details of vlan with ID 12345678, and not list virtual server or hardware server.": {
+    "other": "EXAMPLE:\n   ${COMMAND_NAME} sl vlan detail 12345678\t--no-vs --no-hardware\n   This command shows details of vlan with ID 12345678, and not list virtual server or hardware server."
+  },
+  "EXAMPLE:\n   ${COMMAND_NAME} sl vlan list -d dal09 --sortby number\n   This commands lists all vlans on current account filtering by datacenter equals to dal09, and sort them by vlan number.\n \nNote: In field Pod, if add (*) indicated that closed soon": {
+    "other": "EXAMPLE:\n   ${COMMAND_NAME} sl vlan list -d dal09 --sortby number\n   This commands lists all vlans on current account filtering by datacenter equals to dal09, and sort them by vlan number.\n \nNote: In field Pod, if add (*) indicated that closed soon"
+  },
   "EXAMPLE:\n   ${COMMAND_NAME} sl vs create -H myvsi -D ibm.com -c 4 -m 4096 -d dal10 -o UBUNTU_16_64 --disk 100 --disk 1000 --vlan-public 413\n\tThis command orders a virtual server instance with hostname is myvsi, domain is ibm.com, 4 cpu cores, 4096M memory, located at datacenter: dal10,\n\toperation system is UBUNTU 16 64 bits, 2 disks, one is 100G, the other is 1000G, and placed at public vlan with ID 413.\n\t${COMMAND_NAME} sl vs create -H myvsi -D ibm.com -c 4 -m 4096 -d dal10 -o UBUNTU_16_64 --disk 100 --disk 1000 --vlan-public 413 --test\n\tThis command tests whether the order is valid with above options before the order is actually placed.\n\t${COMMAND_NAME} sl vs create -H myvsi -D ibm.com -c 4 -m 4096 -d dal10 -o UBUNTU_16_64 --disk 100 --disk 1000 --vlan-public 413 --export ~/myvsi.txt\n\tThis command exports above options to a file: myvsi.txt under user home directory for later use.": {
     "other": "EXAMPLE:\n   ${COMMAND_NAME} sl vs create -H myvsi -D ibm.com -c 4 -m 4096 -d dal10 -o UBUNTU_16_64 --disk 100 --disk 1000 --vlan-public 413\n\tThis command orders a virtual server instance with hostname is myvsi, domain is ibm.com, 4 cpu cores, 4096M memory, located at datacenter: dal10,\n\toperation system is UBUNTU 16 64 bits, 2 disks, one is 100G, the other is 1000G, and placed at public vlan with ID 413.\n\t${COMMAND_NAME} sl vs create -H myvsi -D ibm.com -c 4 -m 4096 -d dal10 -o UBUNTU_16_64 --disk 100 --disk 1000 --vlan-public 413 --test\n\tThis command tests whether the order is valid with above options before the order is actually placed.\n\t${COMMAND_NAME} sl vs create -H myvsi -D ibm.com -c 4 -m 4096 -d dal10 -o UBUNTU_16_64 --disk 100 --disk 1000 --vlan-public 413 --export ~/myvsi.txt\n\tThis command exports above options to a file: myvsi.txt under user home directory for later use."
   },
@@ -4730,8 +4730,8 @@
   "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC": {
     "other": "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC"
   },
-  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.": {
-    "other": "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps."
+  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.": {
+    "other": "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required."
   },
   "Notes": {
     "other": "Notes"
@@ -6281,6 +6281,9 @@
   "Test order": {
     "other": "Test order"
   },
+  "The -c and -m options are for dedicated VSI upgrade, most VSIs will need to upgrade with --flavor.\nSee '${COMMAND_NAME} sl vs options' for flavor keyNames to use.": {
+    "other": "The -c and -m options are for dedicated VSI upgrade, most VSIs will need to upgrade with --flavor.\nSee '${COMMAND_NAME} sl vs options' for flavor keyNames to use."
+  },
   "The ID of one IP address to authorize": {
     "other": "The ID of one IP address to authorize"
   },

plugin/i18n/v2Resources/active.es_ES.json

@@ -4691,8 +4691,8 @@
   "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC": {
     "other": "Nota: IOPS por encima de 6.000 solo disponible en: https://cloud.ibm.com/docs/BlockStorage? topic=BlockStorage-selectDC"
   },
-  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.": {
-    "other": "Nota: Este servidor virtual rearrancará una vez que se haya presentado la orden de actualización.\nLa instancia se detiene hasta que la transacción de actualización se haya completado. Sin embargo, para la Red no es necesario rearrancar.\n\nEJEMPLO:\n ${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n Este mandato actualiza la instancia de servidor virtual con el ID 12345678 y establece el número de núcleos de CPU en 8, la memoria en 8192M y la velocidad de puerto de red en 1000 Mbps."
+  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.": {
+    "other": "Nota: Este servidor virtual rearrancará una vez que se haya presentado la orden de actualización.\nLa instancia se detiene hasta que la transacción de actualización se haya completado. Sin embargo, para la Red no es necesario rearrancar."
   },
   "Notes": {
     "other": "Notas"

plugin/i18n/v2Resources/active.fr_FR.json

@@ -4691,8 +4691,8 @@
   "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC": {
     "other": "Remarque : les IOPS supérieures à 6000 sont disponibles uniquement dans : https://cloud.ibm.com/docs/BlockStorage? topic=BlockStorage-selectDC"
   },
-  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.": {
-    "other": "Remarque : ce serveur virtuel sera réamorcé une fois la commande de mise à niveau passée.\nL' instance est arrêtée jusqu'à la fin de la transaction de mise à niveau. Toutefois, pour le réseau, aucun réamorçage n'est requis.\n\nEXEMPLE :\n ${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n Cette commande met à niveau l'instance de serveur virtuel avec l'ID 12345678 et définit le nombre de coeurs d'UC sur 8, la mémoire sur 8192M, la vitesse du port réseau sur 1000 Mbps."
+  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.": {
+    "other": "Remarque : ce serveur virtuel sera réamorcé une fois la commande de mise à niveau passée.\nL' instance est arrêtée jusqu'à la fin de la transaction de mise à niveau. Toutefois, pour le réseau, aucun réamorçage n'est requis."
   },
   "Notes": {
     "other": "Notes"

plugin/i18n/v2Resources/active.it_IT.json

@@ -4691,8 +4691,8 @@
   "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC": {
     "other": "Nota: IOPS oltre 6.000 disponibili solo in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC"
   },
-  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.": {
-    "other": "Nota: questo server virtuale verrà riavviato una volta effettuato l'ordine di aggiornamento.\n L'istanza viene arrestata fino a quando non viene completata la transazione di aggiornamento. Tuttavia, per la rete, non è richiesto alcun riavvio.\n\nESEMPIO:\n ${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n Questo comando aggiorna l'istanza del server virtuale con ID 12345678 e imposta il numero di core CPU su 8, la memoria su 8192M, la velocità della porta di rete su 1000 Mbps."
+  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.": {
+    "other": "Nota: questo server virtuale verrà riavviato una volta effettuato l'ordine di aggiornamento.\n L'istanza viene arrestata fino a quando non viene completata la transazione di aggiornamento. Tuttavia, per la rete, non è richiesto alcun riavvio."
   },
   "Notes": {
     "other": "Note"

plugin/i18n/v2Resources/active.ja_JP.json

@@ -4691,8 +4691,8 @@
   "Note: IOPS above 6,000 available only in: https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-selectDC": {
     "other": "注: 6,000 を超える IOPS は、https://cloud.ibm.com/docs/BlockStorage? topic=BlockStorage-selectDC でのみ使用可能です。"
   },
-  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.\n\nEXAMPLE:\n\t${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n\tThis commands upgrades virtual server instance with ID 12345678 and set number of CPU cores to 8, memory to 8192M, network port speed to 1000 Mbps.": {
-    "other": "注: この仮想サーバーは、アップグレード注文が placed.\nThe インスタンスは、アップグレード・トランザクションが完了するまで停止されます。 ただし、ネットワークの場合、リブートは行われません。required.\n\nEXAMPLE:\n ${COMMAND_NAME} sl vs upgrade 12345678 -c 8 -m 8192 --network 1000\n このコマンドは、ID 12345678 の仮想サーバー・インスタンスをアップグレードし、CPU コアの数を 8、メモリーを 8192M、ネットワーク・ポート速度を 1000 Mbps に設定します。"
+  "Note: This virtual server will be rebooted once the upgrade order is placed.\nThe instance is halted until the upgrade transaction is completed. However for Network, no reboot is required.": {
+    "other": "注: この仮想サーバーは、アップグレード注文が placed.\nThe インスタンスは、アップグレード・トランザクションが完了するまで停止されます。 ただし、ネットワークの場合、リブートは行われません。required."
   },
   "Notes": {
     "other": "メモ"