Help tweaks

Author: matthewpwilson

docs/README.md

@@ -25,7 +25,8 @@ In order to use the cics-deploy plugin you must first have installed Zowe CLI; f
 <a name="installation"></a>
 ## Installation
 
-To install the cics-deploy plugin to Zowe CLI do the following: TO BE DETERMINED; NPM, SOMETHING, SOMETHING.
+To install the cics-deploy plugin to Zowe CLI do the following: 
+`zowe plugins install zowe-cli-cics-deploy-plugin`
 
 <a name="generation"></a>
 ## Generating a Bundle from an existing Node.js project

src/cli/deploy/Deploy.definition.ts

@@ -18,10 +18,10 @@ import { DeployBundleDefinition } from "./bundle/DeployBundle.definition";
 const DeployDefinition: ICommandDefinition = {
     name: "deploy",
     aliases: ["d", "dep"],
-    summary: "Deploy a CICS bundle to a CPSM managed (group of) CICS region(s)",
-    description: "Deploy a CICS bundle from zFS into a CPSM managed set of CICS regions. " +
-                 "A BUNDLE resource is installed and ENABLED and made AVAILABLE in the " +
-                 "target CICSplex and scope.",
+    summary: "Deploy a CICS bundle to one or more CICS regions within a CICSplex",
+    description: "Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. " +
+                 "A BUNDLE resource is installed, ENABLED and made AVAILABLE in the " +
+                 "target scope of the CICSplex.",
     type: "group",
     children: [DeployBundleDefinition],
 };

src/cli/deploy/bundle/DeployBundle.definition.ts

@@ -29,7 +29,7 @@ export const DeployBundleDefinition: ICommandDefinition = {
     name: "bundle",
     aliases: ["b", "bun", "bund"],
     summary: "Deploy a CICS bundle",
-    description: "Deploy a CICS bundle from zFS to a CPSM managed group of CICS regions. " +
+    description: "Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. " +
                  "The DFHDPLOY utility is used to install and make available a BUNDLE resource " +
                  "in the target group of CICS regions.",
     type: "command",
@@ -40,16 +40,16 @@ export const DeployBundleDefinition: ICommandDefinition = {
     examples: [
         {
             description: "Deploy a CICS bundle with a specific name and location to a default set of target regions",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir --cics-deploy-profile default`
+            options: `--name EXAMPLE --bundledir /u/example/bundleDir`
         },
         {
             description: "Deploy a CICS bundle, but declare a timeout should the processing take too long",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir --cics-deploy-profile default --timeout 60`
+            options: `--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60`
         },
         {
-            description: "Deploy a CICS bundle to a specific target environment using a specific zosmf profile",
+            description: "Deploy a CICS bundle to a specific target environment using specific zosmf & cics-deploy profiles",
             options: `--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
-                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile zprof`
+                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
         }
     ]
 };

src/cli/shared/Cicshlq.option.ts

@@ -23,7 +23,7 @@ export const CicshlqOption: ICommandOptionDefinition = {
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
-    description: "Specifies the High Level Qualifier (up to 35 characters) at which the CICS " +
+    description: "Specifies the high-level qualifier (up to 35 characters) at which the CICS " +
                  "datasets can be found in the target environment. Use this parameter if you have not set " +
                  "the --cics-deploy-profile option."
 };

src/cli/shared/Cpsmhlq.option.ts

@@ -23,7 +23,7 @@ export const CpsmhlqOption: ICommandOptionDefinition = {
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
-    description: "Specifies the High Level Qualifier (up to 35 characters) at which the CPSM " +
+    description: "Specifies the high-level qualifier (up to 35 characters) at which the CPSM " +
                  "datasets can be found in the target environment. Use this parameter if you have not set " +
                  "the --cics-deploy-profile option."
 };

src/cli/shared/Csdgroup.option.ts

@@ -24,7 +24,7 @@ export const CsdgroupOption: ICommandOptionDefinition = {
     stringLengthRange: [1, MAX_LENGTH],
     description: "Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is " +
                  "deployed then a definition is added to this group; if a bundle is undeployed then the " +
-                 "definition is removed from this group. The CSD group is changed for each CICS system " +
+                 "definition is removed from this group. The definition is added or removed from the CSD of each system " +
                  "that is specified by the --scope option. The --csdgroup and --resgroup options are " +
                  "mutually exclusive, one of them must be set if --scope is specified."
 };

src/cli/shared/Jobcard.option.ts

@@ -21,7 +21,7 @@ export const JobcardOption: ICommandOptionDefinition = {
     type: "string",
     description: "Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter " +
                  "if you need to tailor the job card and you have not set the --cics-deploy-profile " +
-                 "option.",
+                 "option. You can separate multiple lines of the jobcard with \\n.",
     defaultValue: "//DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT",
     required: false
 };

src/cli/shared/Name.option.ts

@@ -23,6 +23,6 @@ export const NameOption: ICommandOptionDefinition = {
     type: "string",
     required: true,
     stringLengthRange: [1, MAX_LENGTH],
-    description: "Specifies the name of the CICS bundle (up to 8 characters) to deploy or undeploy."
+    description: "Specifies the name of the CICS BUNDLE resource (up to 8 characters) to deploy or undeploy."
 };
 

src/cli/undeploy/Undeploy.definition.ts

@@ -18,10 +18,10 @@ import { UndeployBundleDefinition } from "./bundle/UndeployBundle.definition";
 const UndeployDefinition: ICommandDefinition = {
     name: "undeploy",
     aliases: ["u", "udep"],
-    summary: "Undeploy a CICS bundle from a CPSM managed (group of) CICS region(s)",
-    description: "Undeploy a CICS bundle from a CPSM managed set of CICS regions. " +
+    summary: "Undeploy a CICS bundle from one or more CICS regions within a CICSplex",
+    description: "Undeploy a CICS bundle from one or more CICS regions within a CICSplex. " +
                  "A BUNDLE resource is made UNAVAILABLE, it is then DISABLED and " +
-                 "DISCARDED from the target CICSplex and scope.",
+                 "DISCARDED from the target scope with the CICSplex.",
     type: "group",
     children: [UndeployBundleDefinition]
 };

src/cli/undeploy/bundle/UndeployBundle.definition.ts

@@ -28,7 +28,7 @@ export const UndeployBundleDefinition: ICommandDefinition = {
     name: "bundle",
     aliases: ["b", "bun", "bund"],
     summary: "Deploy a CICS bundle",
-    description: "Undeploy a CICS bundle from a CPSM managed group of CICS regions. " +
+    description: "Undeploy a CICS bundle from one or more CICS regions within a CICSplex. " +
                  "The DFHDPLOY utility is used to undeploy and remove a BUNDLE resource " +
                  "from the target group of CICS regions.",
     type: "command",
@@ -38,17 +38,17 @@ export const UndeployBundleDefinition: ICommandDefinition = {
     profile: { required: ["zosmf"], optional: ["cics-deploy"] },
     examples: [
         {
-            description: "Undeploy a CICS bundle from a default set of target regions",
-            options: `--name EXAMPLE --cics-deploy-profile default`
+            description: "Undeploy a CICS bundle using the default cics-deploy profile",
+            options: `--name EXAMPLE`
         },
         {
             description: "Undeploy a CICS bundle, and declare a timeout should the processing take too long",
-            options: `--name EXAMPLE --cics-deploy-profile default --timeout 60`
+            options: `--name EXAMPLE --timeout 60`
         },
         {
-            description: "Undeploy a CICS bundle from a specific target environment using a specific zosmf profile",
+            description: "Undeploy a CICS bundle from a specific target environment using specific zosmf and cics-deploy profiles",
             options: `--name EXAMPLE --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
-                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile zprof`
+                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
         }
     ]
 };