Skip to content

Commit 0191da3

Browse files
matthewpwilsonmatthewpwilson
authored
Merge pull request #42 from matthewpwilson/help
Help tweaks
2 parents 8f99fa2 + aaaa79e commit 0191da3

File tree

14 files changed

+43
-42
lines changed

14 files changed

+43
-42
lines changed

‎__tests__/cli/deploy/__snapshots__/Deploy.definition.test.ts.snap

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ import { DeployBundleDefinition } from \\"./bundle/DeployBundle.definition\\";
2121
const DeployDefinition: ICommandDefinition = {
2222
name: \\"deploy\\",
2323
aliases: [\\"d\\", \\"dep\\"],
24-
summary: \\"Deploy a CICS bundle to a CPSM managed (group of) CICS region(s)\\",
25-
description: \\"Deploy a CICS bundle from zFS into a CPSM managed set of CICS regions. \\" +
26-
\\"A BUNDLE resource is installed and ENABLED and made AVAILABLE in the \\" +
27-
\\"target CICSplex and scope.\\",
24+
summary: \\"Deploy a CICS bundle to one or more CICS regions within a CICSplex\\",
25+
description: \\"Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. \\" +
26+
\\"A BUNDLE resource is installed, ENABLED and made AVAILABLE in the \\" +
27+
\\"target scope of the CICSplex.\\",
2828
type: \\"group\\",
2929
children: [DeployBundleDefinition],
3030
};

‎__tests__/cli/deploy/bundle/__snapshots__/DeployBundle.definition.test.ts.snap

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export const DeployBundleDefinition: ICommandDefinition = {
3232
name: \\"bundle\\",
3333
aliases: [\\"b\\", \\"bun\\", \\"bund\\"],
3434
summary: \\"Deploy a CICS bundle\\",
35-
description: \\"Deploy a CICS bundle from zFS to a CPSM managed group of CICS regions. \\" +
35+
description: \\"Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. \\" +
3636
\\"The DFHDPLOY utility is used to install and make available a BUNDLE resource \\" +
3737
\\"in the target group of CICS regions.\\",
3838
type: \\"command\\",
@@ -43,16 +43,16 @@ export const DeployBundleDefinition: ICommandDefinition = {
4343
examples: [
4444
{
4545
description: \\"Deploy a CICS bundle with a specific name and location to a default set of target regions\\",
46-
options: \`--name EXAMPLE --bundledir /u/example/bundleDir --cics-deploy-profile default\`
46+
options: \`--name EXAMPLE --bundledir /u/example/bundleDir\`
4747
},
4848
{
4949
description: \\"Deploy a CICS bundle, but declare a timeout should the processing take too long\\",
50-
options: \`--name EXAMPLE --bundledir /u/example/bundleDir --cics-deploy-profile default --timeout 60\`
50+
options: \`--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60\`
5151
},
5252
{
53-
description: \\"Deploy a CICS bundle to a specific target environment using a specific zosmf profile\\",
53+
description: \\"Deploy a CICS bundle to a specific target environment using specific zosmf & cics-deploy profiles\\",
5454
options: \`--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP \` +
55-
\`--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile zprof\`
55+
\`--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics\`
5656
}
5757
]
5858
};

‎__tests__/cli/undeploy/__snapshots__/Undeploy.definition.test.ts.snap

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ import { UndeployBundleDefinition } from \\"./bundle/UndeployBundle.definition\\
2121
const UndeployDefinition: ICommandDefinition = {
2222
name: \\"undeploy\\",
2323
aliases: [\\"u\\", \\"udep\\"],
24-
summary: \\"Undeploy a CICS bundle from a CPSM managed (group of) CICS region(s)\\",
25-
description: \\"Undeploy a CICS bundle from a CPSM managed set of CICS regions. \\" +
24+
summary: \\"Undeploy a CICS bundle from one or more CICS regions within a CICSplex\\",
25+
description: \\"Undeploy a CICS bundle from one or more CICS regions within a CICSplex. \\" +
2626
\\"A BUNDLE resource is made UNAVAILABLE, it is then DISABLED and \\" +
27-
\\"DISCARDED from the target CICSplex and scope.\\",
27+
\\"DISCARDED from the target scope with the CICSplex.\\",
2828
type: \\"group\\",
2929
children: [UndeployBundleDefinition]
3030
};

‎__tests__/cli/undeploy/bundle/__snapshots__/UndeployBundle.definition.test.ts.snap

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export const UndeployBundleDefinition: ICommandDefinition = {
3131
name: \\"bundle\\",
3232
aliases: [\\"b\\", \\"bun\\", \\"bund\\"],
3333
summary: \\"Deploy a CICS bundle\\",
34-
description: \\"Undeploy a CICS bundle from a CPSM managed group of CICS regions. \\" +
34+
description: \\"Undeploy a CICS bundle from one or more CICS regions within a CICSplex. \\" +
3535
\\"The DFHDPLOY utility is used to undeploy and remove a BUNDLE resource \\" +
3636
\\"from the target group of CICS regions.\\",
3737
type: \\"command\\",
@@ -41,17 +41,17 @@ export const UndeployBundleDefinition: ICommandDefinition = {
4141
profile: { required: [\\"zosmf\\"], optional: [\\"cics-deploy\\"] },
4242
examples: [
4343
{
44-
description: \\"Undeploy a CICS bundle from a default set of target regions\\",
45-
options: \`--name EXAMPLE --cics-deploy-profile default\`
44+
description: \\"Undeploy a CICS bundle using the default cics-deploy profile\\",
45+
options: \`--name EXAMPLE\`
4646
},
4747
{
4848
description: \\"Undeploy a CICS bundle, and declare a timeout should the processing take too long\\",
49-
options: \`--name EXAMPLE --cics-deploy-profile default --timeout 60\`
49+
options: \`--name EXAMPLE --timeout 60\`
5050
},
5151
{
52-
description: \\"Undeploy a CICS bundle from a specific target environment using a specific zosmf profile\\",
52+
description: \\"Undeploy a CICS bundle from a specific target environment using specific zosmf and cics-deploy profiles\\",
5353
options: \`--name EXAMPLE --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP \` +
54-
\`--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile zprof\`
54+
\`--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics\`
5555
}
5656
]
5757
};

‎docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ In order to use the cics-deploy plugin you must first have installed Zowe CLI; f
2525
<a name="installation"></a>
2626
## Installation
2727

28-
To install the cics-deploy plugin to Zowe CLI do the following: TO BE DETERMINED; NPM, SOMETHING, SOMETHING.
28+
To install the cics-deploy plugin to Zowe CLI do the following:
29+
`zowe plugins install zowe-cli-cics-deploy-plugin`
2930

3031
<a name="generation"></a>
3132
## Generating a Bundle from an existing Node.js project

‎src/cli/deploy/Deploy.definition.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ import { DeployBundleDefinition } from "./bundle/DeployBundle.definition";
1818
const DeployDefinition: ICommandDefinition = {
1919
name: "deploy",
2020
aliases: ["d", "dep"],
21-
summary: "Deploy a CICS bundle to a CPSM managed (group of) CICS region(s)",
22-
description: "Deploy a CICS bundle from zFS into a CPSM managed set of CICS regions. " +
23-
"A BUNDLE resource is installed and ENABLED and made AVAILABLE in the " +
24-
"target CICSplex and scope.",
21+
summary: "Deploy a CICS bundle to one or more CICS regions within a CICSplex",
22+
description: "Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. " +
23+
"A BUNDLE resource is installed, ENABLED and made AVAILABLE in the " +
24+
"target scope of the CICSplex.",
2525
type: "group",
2626
children: [DeployBundleDefinition],
2727
};

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export const DeployBundleDefinition: ICommandDefinition = {
2929
name: "bundle",
3030
aliases: ["b", "bun", "bund"],
3131
summary: "Deploy a CICS bundle",
32-
description: "Deploy a CICS bundle from zFS to a CPSM managed group of CICS regions. " +
32+
description: "Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. " +
3333
"The DFHDPLOY utility is used to install and make available a BUNDLE resource " +
3434
"in the target group of CICS regions.",
3535
type: "command",
@@ -40,16 +40,16 @@ export const DeployBundleDefinition: ICommandDefinition = {
4040
examples: [
4141
{
4242
description: "Deploy a CICS bundle with a specific name and location to a default set of target regions",
43-
options: `--name EXAMPLE --bundledir /u/example/bundleDir --cics-deploy-profile default`
43+
options: `--name EXAMPLE --bundledir /u/example/bundleDir`
4444
},
4545
{
4646
description: "Deploy a CICS bundle, but declare a timeout should the processing take too long",
47-
options: `--name EXAMPLE --bundledir /u/example/bundleDir --cics-deploy-profile default --timeout 60`
47+
options: `--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60`
4848
},
4949
{
50-
description: "Deploy a CICS bundle to a specific target environment using a specific zosmf profile",
50+
description: "Deploy a CICS bundle to a specific target environment using specific zosmf & cics-deploy profiles",
5151
options: `--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
52-
`--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile zprof`
52+
`--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
5353
}
5454
]
5555
};

‎src/cli/shared/Cicshlq.option.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const CicshlqOption: ICommandOptionDefinition = {
2323
type: "string",
2424
required: false,
2525
stringLengthRange: [1, MAX_LENGTH],
26-
description: "Specifies the High Level Qualifier (up to 35 characters) at which the CICS " +
26+
description: "Specifies the high-level qualifier (up to 35 characters) at which the CICS " +
2727
"datasets can be found in the target environment. Use this parameter if you have not set " +
2828
"the --cics-deploy-profile option."
2929
};

‎src/cli/shared/Cpsmhlq.option.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const CpsmhlqOption: ICommandOptionDefinition = {
2323
type: "string",
2424
required: false,
2525
stringLengthRange: [1, MAX_LENGTH],
26-
description: "Specifies the High Level Qualifier (up to 35 characters) at which the CPSM " +
26+
description: "Specifies the high-level qualifier (up to 35 characters) at which the CPSM " +
2727
"datasets can be found in the target environment. Use this parameter if you have not set " +
2828
"the --cics-deploy-profile option."
2929
};

‎src/cli/shared/Csdgroup.option.ts

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

0 commit comments

Comments
 (0)