Provides the cics-deploy plug-in for Zowe CLI https://github.com/zowe/zowe-cli to deploy Node.js and other applications from a workstation to IBM CICS Transaction Server within a CICS bundle. Documentation is available at https://ibm.github.io/zowe-cli-cics-deploy-plugin/
Eclipse Public License 2.0
13
stars
12
forks
source link
Identify required options in command line help #321
From the command line help, it is not fully explicit which options are required for each command. For example, --target-directory is required for push but in the doc there are no required options for push.
From what I can tell, the Zowe CLI convention is to have required arguments as positional, and optional arguments as -- options, except for overrides to profile arguments (these are required if not specified in the profile). The cics-deploy plugin does not have positional arguments.
We could:
add Required. to the description for each required argument not related to profiles:
zowe cics-deploy push bundle --name
zowe cics-deploy deploy bundle --name and --bundle-directory
zowe cics-deploy undeploy bundle --name
Replace text in descriptions:
Use this parameter if you have not set the --cics-deploy-profile option. For help on creating a profile issue the 'zowe profiles create cics-deploy --help' command.
with
This parameter defaults to the value specified in the cics-deploy profile.
As the --cics-deploy-profile does not need to be specified if there is a default profile.
From the command line help, it is not fully explicit which options are required for each command. For example,
--target-directoryis required forpushbut in the doc there are no required options forpush.From what I can tell, the Zowe CLI convention is to have required arguments as positional, and optional arguments as
--options, except for overrides to profile arguments (these are required if not specified in the profile). The cics-deploy plugin does not have positional arguments.We could:
add
Required.to the description for each required argument not related to profiles:--name--nameand--bundle-directory--nameReplace text in descriptions:
Use this parameter if you have not set the --cics-deploy-profile option. For help on creating a profile issue the 'zowe profiles create cics-deploy --help' command.withThis parameter defaults to the value specified in the cics-deploy profile.As the--cics-deploy-profiledoes not need to be specified if there is a default profile.add the above description to
--target-directory.