Merge branch 'dev' into dev

markcocker · web-flow · commit 2031c93bb911 · 2019-06-24T11:48:46.000+01:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 # zowe-cli-cics-deploy-plugin
 
-This project provides a plug-in for [Zowe CLI](https://github.com/zowe/zowe-cli) to deploy applications developed on a workstation to IBM CICS Transaction Server for z/OS (CICS). It aims to provide an experience similar to deploying to a cloud platform when deploying to CICS. It will also provide low-level commands for performing individual steps of the deployment process that could be used as part of a CI/CD pipeline.
+This project provides a plug-in for [Zowe CLI](https://github.com/zowe/zowe-cli) to deploy applications developed on a workstation to IBM® CICS® Transaction Server for z/OS® (CICS). It aims to provide an experience similar to deploying to a cloud platform when deploying to CICS. It will also provide low-level commands for performing individual steps of the deployment process that could be used as part of a CI/CD pipeline.
 
 ## Installing
 
diff --git a/docs/pages/cdp/cdp-Common-Errors.md b/docs/pages/cdp/cdp-Common-Errors.md
@@ -12,8 +12,8 @@ folder: cdp
 
 If you experience errors while using the cics-deploy plug-in, check the following potential causes before investigating further:
 
-* CICS must be authorized to read the bundle directory `META-INF`.
-* The port specified by the `--port` argument of the `cics-deploy generate bundle` command *must* be free on z/OS before you attempt to deploy an application.
+* CICS® must be authorized to read the bundle directory `META-INF`.
+* The port specified by the `--port` argument of the `cics-deploy generate bundle` command *must* be free on z/OS® before you attempt to deploy an application.
 * If you set a `WORK_DIR` in the CICS Node.js application profile, such as `nodejsapps/<your application name>.profile`, it must be *writeable* by CICS.
 
 ## Deployment errors
@@ -38,8 +38,8 @@ If you experience errors while using the cics-deploy plug-in, check the followin
 ### Command error: DFHDPLOY stopped processing due to an error
 
 *Possible causes:*
-* The `--scope` and/or `--cicsplex` settings for the current deploy profile are wrong, and don't correctly identify a current CICS system, CICS System Group and/or a correct CICSPlex respectively.
-* The CMAS for the current CICSPlex is inactive.
+* The `--scope` and/or `--cicsplex` settings for the current deploy profile are wrong, and don't correctly identify a current CICS system, CICS System Group and/or a correct CICSPlex® respectively.
+* The CMAS for the cicsplex is inactive.
 * CPSM is not functioning correctly.
 
 *Representative output:*
diff --git a/docs/pages/cdp/cdp-Creating-Zowe-CLI-profiles.md b/docs/pages/cdp/cdp-Creating-Zowe-CLI-profiles.md
@@ -17,14 +17,14 @@ The Zowe CLI lets you define arguments and options for commands in multiple ways
 
 Therefore by creating and setting options in the following profiles, they will become your defaults and you do not need to repeat them when using Zowe CLI commands unless you wish to override them. Further details are in [Understanding command option order of precedence](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#understanding-command-option-order-of-precedence).
 
-The CICS deploy plug-in makes use of the following profiles:
+The CICS® deploy plug-in makes use of the following profiles:
 
-| Profile | Used by command | Connects to z/OS server |
+| Profile | Used by command | Connects to z/OS® server |
 | --- | --- | --- |
 | [z/OSMF profile](#zosmf-profile) | **zowe cics-deploy ...** <br /> zowe console ... <br />  zowe zos-files ... <br />  zowe zos-jobs ... <br />  zowe zos-tso ... <br />  zowe zos-workflows ... <br />  zowe zosmf ... <br />  zowe provisioing ... | z/OSMF |
 | [SSH profile](#ssh-profile) | **zowe cics-deploy push ...** <br />  zowe zos-uss ... | SSH |
 | [CICS deploy profile](#cics-deploy-profile) | **zowe cics-deploy ...** |  |
-| [CICS profile](#cics-profile) | **zowe cics-deploy push ...** <br />  zowe cics ... | CICSPlex SM WUI |
+| [CICS profile](#cics-profile) | **zowe cics-deploy push ...** <br />  zowe cics ... | CICSPlex® SM WUI |
 
 ### z/OSMF profile
 
diff --git a/docs/pages/cdp/cdp-Deploying-a-CICS-policy.md b/docs/pages/cdp/cdp-Deploying-a-CICS-policy.md
@@ -2,7 +2,7 @@
 title: Deploying a CICS policy
 tags: [tutorial]
 keywords:
-summary: "The following steps take you through deploying a sample CICS bundle containing a policy."
+summary: "The following steps take you through deploying a sample CICS® bundle containing a policy."
 sidebar: cdp_sidebar
 permalink: cdp-Deploying-a-CICS-policy.html
 folder: cdp
diff --git a/docs/pages/cdp/cdp-Deploying-a-nodejs-application.md b/docs/pages/cdp/cdp-Deploying-a-nodejs-application.md
@@ -2,7 +2,7 @@
 title: Deploying a Node.js application
 tags: [tutorial]
 keywords:
-summary: "The following steps take you through creating a Node.js application using the Express Application Generator then deploying it to CICS."
+summary: "The following steps take you through creating a Node.js application using the Express Application Generator then deploying it to CICS®."
 sidebar: cdp_sidebar
 permalink: cdp-Deploying-a-Nodejs-application.html
 folder: cdp
@@ -11,7 +11,7 @@ toc: true
 
 ### Before you begin
 
-CICS TS V5.5 introduced support to run Node.js applications and is required by this tutorial. If you do not have a CICS TS V5.5 region, use the steps in [Provisioning a CICS region using z/OS PT](cdp-Provisioning-a-CICS-region-using-zospt) to provision one, or speak to your CICS system administrator.
+CICS TS V5.5 introduced support to run Node.js applications and is required by this tutorial. If you do not have a CICS TS V5.5 region, use the steps in [Provisioning a CICS region using z/OS® PT](cdp-Provisioning-a-CICS-region-using-zospt) to provision one, or speak to your CICS system administrator.
 
 ### Procedure
 
diff --git a/docs/pages/cdp/cdp-Deploying-using-individual-actions.md b/docs/pages/cdp/cdp-Deploying-using-individual-actions.md
@@ -2,7 +2,7 @@
 title: Deploying using individual actions
 tags: [tutorial]
 keywords:
-summary: "The following steps take you through the individual actions to deploy a Node.js application in CICS."
+summary: "The following steps take you through the individual actions to deploy a Node.js application in CICS®."
 sidebar: cdp_sidebar
 permalink: cdp-Deploying-using-individual-actions.html
 folder: cdp
@@ -21,7 +21,6 @@ However, there may be situations where you need more control of these actions or
 ### Undeploy a CICS bundle
 
 Undeploying a CICS bundle disables the CICS bundle resource (BUNDLE) in CICS. Disabling the BUNDLE causes the resources defined in it to also be disabled. For Node.js applications, CICS sends a SIGTERM signal that can be handled in the application to stop in a controlled manner, such as stopping new requests and completing existing requests. Once the CICS bundle has been disabled it is then discarded in CICS.
-
 ```console
 zowe cics-deploy undeploy bundle --name Express
 ```
@@ -32,7 +31,7 @@ Alternatively, if you want to disable the CICS bundle, but to not discard it:
 zowe cics-deploy undeploy bundle --name Express --target-state disabled
 ```
 
-{% include note.html content="This command does not remove the CICS bundle from the z/OS directory." %}
+{% include note.html content="This command does not remove the CICS bundle from the z/OS® directory." %}
 
 ### Upload a CICS bundle to z/OS
 
diff --git a/docs/pages/cdp/cdp-Installing.md b/docs/pages/cdp/cdp-Installing.md
@@ -25,7 +25,7 @@ toc: false
     npm install -g @brightside/core@lts-incremental
     ```
 
-3. Install the cics plugin:
+3. Install the CICS® plugin:
 
     ```console
     zowe plugins install @brightside/cics@lts-incremental
diff --git a/docs/pages/cdp/cdp-Log-and-trace-files.md b/docs/pages/cdp/cdp-Log-and-trace-files.md
@@ -2,15 +2,15 @@
 title: Log and trace files
 tags: [troubleshooting]
 keywords:
-summary: "When you use Zowe, log and trace files are written on both your local workstation and z/OS."
+summary: "When you use Zowe, log and trace files are written on both your local workstation and z/OS®."
 sidebar: cdp_sidebar
 permalink: cdp-Log-and-trace-files.html
 folder: cdp
 ---
 
 ### Console output
 
-All Zowe CLI CICS deploy plug-in commands send output to the console when invoked. Very often, enough information is provided for you to diagnose and pinpoint the cause of a problem. The commands `cics-deploy push`, `cics-deploy deploy` and `cics-deploy undeploy` accept a `--verbose` command-line option which can generate extra information if needed.  
+All Zowe CLI CICS® deploy plug-in commands send output to the console when invoked. Very often, enough information is provided for you to diagnose and pinpoint the cause of a problem. The commands `cics-deploy push`, `cics-deploy deploy` and `cics-deploy undeploy` accept a `--verbose` command-line option which can generate extra information if needed.
 
 ### zowe.log
 
@@ -60,6 +60,6 @@ They can all be useful when identifying the cause of an error, especially STDERR
 
 ### JES job logs
 
-If you are familiar with the z/OS environment, you can often find some useful diagnostics by accessing the JES job log associated with the CICS region you deployed to.  The `cics-deploy push` command outputs the job IDs for all the CICS regions in the scope after a deployment.  The MSGUSR, SYSPRINT, SYSOUT and JESMSGLG spool files can all provide useful information.   If you are not so fluent with the world of z/OS, you may need to discuss your needs with one of your organization's CICS system administrators.
+If you are familiar with the z/OS environment, you can often find some useful diagnostics by accessing the JES job log associated with the CICS region you deployed to. The `cics-deploy push` command outputs the job IDs for all the CICS regions in the scope after a deployment. The MSGUSR, SYSPRINT, SYSOUT and JESMSGLG spool files can all provide useful information. If you are not so fluent with the world of z/OS, you may need to discuss your needs with one of your organization's CICS system administrators.
 
 {% include note.html content="If you use [Visual Studio Code](https://code.visualstudio.com/) as your editor, there is a [Zowe extension](https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe) that enables you to interact with USS files and examine JES job logs from your local workstation." %}
diff --git a/docs/pages/cdp/cdp-Preparing-a-zOS-PT-image.md b/docs/pages/cdp/cdp-Preparing-a-zOS-PT-image.md
@@ -2,7 +2,7 @@
 title: Preparing a z/OS Provisioning Toolkit image
 tags: [tutorial]
 keywords:
-summary: "The following steps take you through preparing a z/OS Provisioning Toolkit image for CICS, and optionally include an application in the image."
+summary: "The following steps take you through preparing a z/OS® Provisioning Toolkit image for CICS®, and optionally include an application in the image."
 sidebar: cdp_sidebar
 permalink: cdp-Preparing-a-zOS-PT-image.html
 folder: cdp
@@ -13,8 +13,12 @@ The [z/OS Provisioning Toolkit](https://developer.ibm.com/mainframe/products/zos
 
 z/OS PT uses configuration and files in an *image* as input to z/OSMF workflows to provision a CICS region. The image is typically prepared by a CICS system administrator. This tutorial provides two alternative approaches to preparing a z/OS PT image:
 
-* [Prepare a z/OS PT image for CICS](#prepare-a-zos-pt-image-for-cics) - no application is included in the image, and the `zosptfile` is kept separate to the application source.
-* [Prepare a z/OS PT image for CICS including an application](#prepare-a-zos-pt-image-for-cics-including-an-application) - the application is provisioned together with the CICS region, and the `zosptfile` is kept with the application source.
+- [Prepare a z/OS PT image for CICS](#prepare-a-zos-pt-image-for-cics)
+  - [Procedure](#procedure)
+  - [Results](#results)
+- [Prepare a z/OS PT image for CICS including an application](#prepare-a-zos-pt-image-for-cics-including-an-application)
+  - [Procedure](#procedure-1)
+  - [Results](#results-1)
 
 ### Prepare a z/OS PT image for CICS
 
diff --git a/docs/pages/cdp/cdp-Provisioning-a-CICS-region.md b/docs/pages/cdp/cdp-Provisioning-a-CICS-region.md
@@ -2,7 +2,7 @@
 title: Provisioning a CICS region
 tags: [tutorial]
 keywords:
-summary: "The following steps take you through provisioning a CICS region from a z/OS Provisioning Toolkit image. You can then deploy and test applications using the CICS region."
+summary: "The following steps take you through provisioning a CICS® region from a z/OS® Provisioning Toolkit image. You can then deploy and test applications using the CICS region."
 sidebar: cdp_sidebar
 permalink: cdp-Provisioning-a-CICS-region.html
 folder: cdp
diff --git a/docs/pages/cdp/cdp-Requirements-on-zOS.md b/docs/pages/cdp/cdp-Requirements-on-zOS.md
@@ -2,7 +2,7 @@
 title: Requirements on z/OS
 tags: [getting_started, requirements]
 keywords:
-summary: "The cics-deploy plug-in is dependent on several servers and facilities that need to be set up on z/OS."
+summary: "The cics-deploy plug-in is dependent on several servers and facilities that need to be set up on z/OS®."
 sidebar: cdp_sidebar
 permalink: cdp-Requirements-on-zOS.html
 folder: cdp
@@ -11,7 +11,7 @@ toc: false
 
 ### z/OS Management Facility
 
-A [z/OS Management Facility (z/OSMF)](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua300/IZUHPINFO_PartConfiguring.htm) server is required to run the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p), [`zowe cics-deploy deploy bundle`](cdp-CLIReadMe#deploy--d--dep), and [`zowe cics-deploy undeploy bundle`](cdp-CLIReadMe#undeploy--u--udep) commands. These commands call the API for [`zowe zos-jobs submit`](https://github.com/zowe/zowe-cli/blob/master/docs/CLIReadme.md#module-submit) to submit JCL to execute the DFHDPLOY utility to deploy and undeploy CICS bundles.
+A [z/OS Management Facility (z/OSMF)](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua300/IZUHPINFO_PartConfiguring.htm) server is required to run the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p), [`zowe cics-deploy deploy bundle`](cdp-CLIReadMe#deploy--d--dep), and [`zowe cics-deploy undeploy bundle`](cdp-CLIReadMe#undeploy--u--udep) commands. These commands call the API for [`zowe zos-jobs submit`](https://github.com/zowe/zowe-cli/blob/master/docs/CLIReadme.md#module-submit) to submit JCL to execute the DFHDPLOY utility to deploy and undeploy CICS® bundles.
 
 The z/OSMF server is also required by the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p) command when it uses the API for [`zowe zos-files upload dir-to-uss`](https://github.com/zowe/zowe-cli/blob/master/docs/CLIReadme.md#command-dir-to-uss) to copy a CICS bundle to a z/OS directory.
 
@@ -21,11 +21,11 @@ The [z/OS Secure SHell daemon (sshd)](https://www.ibm.com/support/knowledgecente
 
 ### DFHDPLOY utility
 
-The [DFHDPLOY](https://www.ibm.com/support/knowledgecenter/SSGMCP_5.5.0/applications/deploying/dfhdploy_overview.html) utility is provided with IBM CICS Transaction Server (CICS) and is required to run the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p), [`zowe cics-deploy deploy bundle`](cdp-CLIReadMe#deploy--d--dep), and [`zowe cics-deploy undeploy bundle`](cdp-CLIReadMe#undeploy--u--udep) commands. These commands start DFHDPLOY with a script to perform deploy and undeploy operations.
+The [DFHDPLOY](https://www.ibm.com/support/knowledgecenter/SSGMCP_5.5.0/applications/deploying/dfhdploy_overview.html) utility is provided with IBM® CICS Transaction Server (CICS) and is required to run the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p), [`zowe cics-deploy deploy bundle`](cdp-CLIReadMe#deploy--d--dep), and [`zowe cics-deploy undeploy bundle`](cdp-CLIReadMe#undeploy--u--udep) commands. These commands start DFHDPLOY with a script to perform deploy and undeploy operations.
 
 ### CICSPlex System Manager
 
-CICSPlex System Manager \(CPSM\) is provided with CICS and is required to run the DFHDPLOY utility, and for the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p) command to query application resources via the CICS Management Client Interface (CMCI). CPSM should be connected to the CICS regions into which the application is being installed.
+CICSPlex® System Manager \(CPSM\) is provided with CICS and is required to run the DFHDPLOY utility, and for the [`zowe cics-deploy push bundle`](cdp-CLIReadMe#push--p) command to query application resources via the CICS Management Client Interface (CMCI). CPSM should be connected to the CICS regions into which the application is being installed.
 
 ### Node.js SDK
 
diff --git a/docs/pages/cdp/cdp-Tutorials-overview.md b/docs/pages/cdp/cdp-Tutorials-overview.md
@@ -2,7 +2,7 @@
 title: Tutorials overview
 tags: [tutorial]
 keywords:
-summary: "Summary of the tutorials to provision a CICS region and deploy applications to it."
+summary: "Summary of the tutorials to provision a CICS® region and deploy applications to it."
 sidebar: cdp_sidebar
 permalink: cdp-Tutorials-overview.html
 folder: cdp
@@ -11,11 +11,12 @@ toc: true
 
 Firstly, you will need a CICS region:
 
-* The z/OS Provisioning Toolkit enables you to provision CICS regions yourself:
+* The z/OS® Provisioning Toolkit enables you to provision CICS regions yourself:
 
   * [Preparing a z/OS Provisioning Toolkit image](cdp-Preparing-a-zOS-PT-image) - prepare a z/OS Provisioning Toolkit image for CICS, and optionally include an application in the image.
 
   * [Provisioning a CICS region](cdp-Provisioning-a-CICS-region) - provision a CICS region from a z/OS Provisioning Toolkit image.
+  * [Provisioning a CICS region](cdp-Provisioning-a-CICS-region) - provision a CICS region from a z/OS Provisioning Toolkit image.
 
 * Alternatively, work with your CICS and z/OS system administrators [Creating Zowe CLI profiles](cdp-Creating-Zowe-CLI-profiles) based on the z/OS system and CICS region you can use.
 
diff --git a/docs/pages/cdp/cdp-Zowe-CLI-CICS-deploy-plug-in.md b/docs/pages/cdp/cdp-Zowe-CLI-CICS-deploy-plug-in.md
@@ -2,7 +2,7 @@
 title: Zowe CLI CICS deploy plug-in
 tags: [getting_started]
 keywords:
-summary: "The cics-deploy plug-in extends the Zowe command line interface (CLI) to deploy applications developed on a workstation to IBM CICS Transaction Server for z/OS (CICS). The Zowe CLI and plug-ins provide a simple and streamlined way to interact with IBM z/OS."
+summary: "The cics-deploy plug-in extends the Zowe command line interface (CLI) to deploy applications developed on a workstation to IBM® CICS® Transaction Server for z/OS® (CICS). The Zowe CLI and plug-ins provide a simple and streamlined way to interact with IBM z/OS."
 sidebar: cdp_sidebar
 permalink: index.html
 folder: cdp
diff --git a/docs/pages/cdp/cdp-Zowe-CLI-profiles.md b/docs/pages/cdp/cdp-Zowe-CLI-profiles.md
diff --git a/docs/pages/cdp/cdp-cics-bundles.md b/docs/pages/cdp/cdp-cics-bundles.md
diff --git a/docs/pages/cdp/cdp-zowe-and-cli.md b/docs/pages/cdp/cdp-zowe-and-cli.md
