Merge pull request #286 from markcocker/dev

Update doc file names to be consistent with title

Author: cxharris

docs/_data/sidebars/cdp_sidebar.yml

@@ -6,86 +6,87 @@ entries:
   folders:
 
   - title: Getting Started
-    url: index.html
+    url: index
     output: web
     folderitems:
 
     - title: Zowe CLI CICS deploy plug-in
-      url: index.html
+      url: index
       output: web
 
     - title: Requirements on z/OS
-      url: cdp-Requirements.html
+      url: cdp-Requirements-on-zOS
       output: web
 
     - title: Installing
-      url: cdp-Installing.html
+      url: cdp-Installing
       output: web
 
     - title: Creating Zowe CLI profiles
-      url: cdp-Creating-Zowe-CLI-profiles.html
+      url: cdp-Creating-Zowe-CLI-profiles
       output: web
 
   - title: Tutorials
-    url: cdp-Tutorials-overview.html
+    url: cdp-Tutorials-overview
     output: web
     folderitems:
 
     - title: Tutorials overview
-      url: cdp-Tutorials-overview.html
+      url: cdp-Tutorials-overview
       output: web
 
     - title: Preparing a z/OS PT image
-      url: cdp-Preparing-a-zOS-PT-image.html
+      url: cdp-Preparing-a-zOS-PT-image
       output: web
 
     - title: Provisioning a CICS region
-      url: cdp-Provisioning-a-CICS-region.html
+      url: cdp-Provisioning-a-CICS-region
       output: web
 
     - title: Deploying a Node.js application
-      url: cdp-Deploying-a-nodejs-application.html
+      url: cdp-Deploying-a-Nodejs-application
       output: web
 
     - title: Deploying a CICS policy
-      url: cdp-Deploying-a-CICS-policy.html
+      url: cdp-Deploying-a-CICS-policy
       output: web
 
     - title: Deploying using individual actions
-      url: cdp-Deploying-using-individual-actions.html
+      url: cdp-Deploying-using-individual-actions
       output: web
 
   - title: Concepts
-    url: cdp-zowe-and-cli.html
+    url: cdp-Zowe-and-CLI
     output: web
     folderitems:
 
     - title: Zowe and the Zowe CLI
-      url: cdp-zowe-and-cli.html
+      url: cdp-Zowe-and-CLI
       output: web
 
     - title: Zowe CLI profiles
-      url: cdp-zowe-profiles.html
+      url: cdp-Zowe-CLI-profiles
       output: web
 
     - title: CICS bundles
-      url: cdp-cics-bundles.html
+      url: cdp-CICS-bundles
       output: web
 
   - title: Troubleshooting
-    url: cdp-Troubleshooting-General.html
+    url: cdp-Log-and-trace-files
     output: web
     folderitems:
 
     - title: Log and trace files
-      url: cdp-Troubleshooting-General.html
+      url: cdp-Log-and-trace-files
       output: web
 
     - title: Common Errors
-      url: cdp-Common-Errors.html
+      url: cdp-Common-errors
       output: web
 
   - title: Commands
+    url: cdp-CLIReadMe#create--cre
     output: web
     folderitems:
 

docs/pages/cdp/cdp-Common-Errors.md

@@ -1,38 +1,41 @@
 ---
-title: Common Errors
+title: Common errors
 tags: [troubleshooting]
 keywords: 
 summary: "Some common errors can occasionally occur when you attempt to deploy a Node.js application using the cics-deploy plug-in."
 sidebar: cdp_sidebar
-permalink: cdp-Common-Errors.html
+permalink: cdp-Common-errors.html
 folder: cdp
 ---
 
 ## Precautionary checks
+
 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. 
+* 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
+
 {% include note.html content="For further troubleshooting steps, see [Troubleshooting Node.js applications](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.5.0/troubleshooting/node/node-troubleshooting.html)." %}
 
-{% include important.html content="To definitively diagnose a problem based on the suggested symptoms, you might need to refer to one or more [system logs and traces](cdp-Troubleshooting-General) particularly the STDERR Node.js log and the file assigned the MSGUSR DD name in the relevant CICS job. Depending on your familiarity with z/OS and CICS, and your system privileges, you may also need to consult a CICS systems administrator to get to the bottom of certain problems." %}
+{% include important.html content="To definitively diagnose a problem based on the suggested symptoms, you might need to refer to one or more [system logs and traces](cdp-Log-and-trace-files) particularly the STDERR Node.js log and the file assigned the MSGUSR DD name in the relevant CICS job. Depending on your familiarity with z/OS and CICS, and your system privileges, you may also need to consult a CICS systems administrator to get to the bottom of certain problems." %}
 
 ### Application incorrectly deploys in a DISABLED state
+
 *Possible cause*: The port requested by the application is already in use.
 
 *Suggested action*: Choose a new port number after double-checking that it is not in use. Redeploy the application using the new value for the port.
 
 {% include note.html content="An application in a `DISABLED` state does not necessarily indicate an error condition. The `cics-deploy deploy`, `cics-deploy push` and `cics-deploy undeploy` commands allow you to specify a `--target-state` option which you may deliberately choose to set to `DISABLED`." %}
 
 ### 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.
 
-  * CPSM is not functioning correctly.
+*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.
+* CPSM is not functioning correctly.
 
 *Representative output*:
 <pre class="messageText">
@@ -45,11 +48,12 @@ If you experience errors while using the cics-deploy plug-in, check the followin
 </pre>
 
 *Suggested actions*:
-  * Confirm that the `--scope` and `--cicsplex` settings are correct.
 
-  * Ask your CICS Systems Programmer to check that the CMAS for the current CICSPlex is alive and that CPSM is working properly.
+* Confirm that the `--scope` and `--cicsplex` settings are correct.
+* Ask your CICS Systems Programmer to check that the CMAS for the current CICSPlex is alive and that CPSM is working properly.
 
 ### Command error: ... validation of - -cicshlq dataset failed: z/OSMF REST API Error
+
 *Possible cause*: The profile setting for `--cicshlq` is incorrect.
 
 *Representative output*:
@@ -69,6 +73,7 @@ details:
 Check that your `--cicshlq` profile setting matches the value configured for CICS high-level qualifiers in your CICS region. 
 
 ### BUNDLE ... cannot be deployed
+
 *Possible cause*: The `cics.xml` file is malformed.
 
 *Representative output*:
@@ -77,20 +82,22 @@ Check that your `--cicshlq` profile setting matches the value configured for CIC
 15:56:17.419308 :  DFHRL2055I Errors have occurred, processing terminated.
 15:56:17.424650 :  DFHRL2014I Disconnecting from CICSPLEX(CAPLEX).
 ...
-DFHRL0107 I 05/17/2019 15:56:15 CALMAS1 CICSUSER The CICS resource lifecycle manager has started to create the BUNDLE resource      
-           CICSJS02.                                                                                                                
-DFHPI1007 05/17/2019 15:56:15 CALMAS1 COIE 00672 XML to data transformation failed because of incorrect input                       
-           (MISSING_CLOSE_TAG_CHAR manifest) for BUNDLE CICSJS02.                                                                   
-DFHRL0113 E 05/17/2019 15:56:15 CALMAS1 COIE The CICS resource lifecycle manager failed to create the BUNDLE resource CICSJS02      
+DFHRL0107 I 05/17/2019 15:56:15 CALMAS1 CICSUSER The CICS resource lifecycle manager has started to create the BUNDLE resource
+           CICSJS02.
+DFHPI1007 05/17/2019 15:56:15 CALMAS1 COIE 00672 XML to data transformation failed because of incorrect input
+           (MISSING_CLOSE_TAG_CHAR manifest) for BUNDLE CICSJS02.
+DFHRL0113 E 05/17/2019 15:56:15 CALMAS1 COIE The CICS resource lifecycle manager failed to create the BUNDLE resource CICSJS02
            because CICS failed to parse the manifest /u/&lt;your user id>/pushtest2/CICSJSON_1.0.0/META-INF/cics.xml specified in the bundle   
-           root directory. The manifest is not valid.                                                                               
+           root directory. The manifest is not valid.
 </pre>
 
 *Suggested action*: 
 Check that your `cics.xml` file is well-formed.
 
 ## General errors
+
 ### Syntax error: Invalid value length for option
+
 *Possible cause*: The length of the option you provided in a command was either too long or two short.
 
 *Representative output*:
@@ -105,5 +112,5 @@ NODETESTS
 The length must be between 1 and 8 (inclusive)
 </pre>
 
-*Suggested action*: 
-Review the error output text and reissue the original command having corrected the name of the option so that its length falls within acceptable limits. 
+*Suggested action*:
+Review the error output text and reissue the original command having corrected the name of the option so that its length falls within acceptable limits.

docs/pages/cdp/cdp-Creating-Zowe-CLI-profiles.md

@@ -114,7 +114,7 @@ For help on using the options:
 zowe profiles create cics-deploy-profile --help
 ```
 
-To test the cics-deploy profile, follow the steps in [Deploying a Node.js application](cdp-Deploying-a-nodejs-application).
+To test the cics-deploy profile, follow the steps in [Deploying a Node.js application](cdp-Deploying-a-Nodejs-application).
 
 ### CICS profile
 

docs/pages/cdp/cdp-Deploying-a-CICS-policy.md

@@ -43,13 +43,14 @@ This tutorial shows how to download a sample CICS policy and deploy it using the
 
    The warning can be ignored as the default values result in the files being uploaded in text that is suitable for this bundle.
 
-   The CICS BUNDLE resource named `Policy` is defined, installed, and enabled in CICS. If the BUNDLE `Policy` was already defined or installed in CICS, it is undeployed first. As the BUNDLE is enabled, the policy is also enabled. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Troubleshooting-General).
+   The CICS BUNDLE resource named `Policy` is defined, installed, and enabled in CICS. If the BUNDLE `Policy` was already defined or installed in CICS, it is undeployed first. As the BUNDLE is enabled, the policy is also enabled. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Log-and-trace-files).
 
 ### Results
 
-The CICS policy is enabled in the CICS region. When the policy rule is triggered, CICS will write message DFHMP3009 to the CICS region JES job log. For details on how to view this log see [Log and trace files](cdp-Troubleshooting-General).
+The CICS policy is enabled in the CICS region. When the policy rule is triggered, CICS will write message DFHMP3009 to the CICS region JES job log. For details on how to view this log see [Log and trace files](cdp-Log-and-trace-files).
 
 To get started with defining your own CICS policy:
+
 * [Download and start the CICS Explorer](https://www.ibm.com/support/knowledgecenter/en/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/concepts/install_planning_client.html).
 * Create a CICS bundle project using the procedure [Creating a CICS bundle project](https://www.ibm.com/support/knowledgecenter/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/tasks/create_bundle.html).
 * Create a policy using the procedure [To create a policy in a CICS bundle project](https://www.ibm.com/support/knowledgecenter/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/tasks/task_create_policy.html).

docs/pages/cdp/cdp-Deploying-a-nodejs-application.md

@@ -4,7 +4,7 @@ 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."
 sidebar: cdp_sidebar
-permalink: cdp-Deploying-a-nodejs-application.html
+permalink: cdp-Deploying-a-Nodejs-application.html
 folder: cdp
 toc: true
 ---
@@ -31,7 +31,7 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
 
    The Node.js application will start. You can call the application from a browser by using URL [http://localhost:3000/](http://localhost:3000/). To stop the application in the console press CTRL+C.
 
-4. Package the Node.js application into a [CICS bundle](cdp-cics-bundles).
+4. Package the Node.js application into a [CICS bundle](cdp-CICS-bundles).
 
    Make sure that you are in the root directory of the application.
 
@@ -71,7 +71,7 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
    stderr: /u/cicprov/mnt/CICPY000/workdir/CICPY000/myexpressapp/Express/D20190612.T144609.stderr
    PUSH operation completed</pre>
 
-   This results in a CICS BUNDLE resource named `Express` being defined, installed, and enabled in CICS. If the BUNDLE `Express` was already defined or installed in CICS, it is undeployed first. As the BUNDLE is enabled, the application is started. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Troubleshooting-General).
+   This results in a CICS BUNDLE resource named `Express` being defined, installed, and enabled in CICS. If the BUNDLE `Express` was already defined or installed in CICS, it is undeployed first. As the BUNDLE is enabled, the application is started. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Log-and-trace-files).
 
 6. Test the application.
 

docs/pages/cdp/cdp-Deploying-using-individual-actions.md

@@ -9,7 +9,7 @@ folder: cdp
 toc: true
 ---
 
-The `zowe cics-deploy push bundle` command performs a set of actions to deploy applications to CICS, as can be seen in [Deploying a Node.js application](cdp-Deploying-a-nodejs-application). The main actions include:
+The `zowe cics-deploy push bundle` command performs a set of actions to deploy applications to CICS, as can be seen in [Deploying a Node.js application](cdp-Deploying-a-Nodejs-application). The main actions include:
 
 * undeploy the old version of the CICS bundle in CICS
 * upload the new version of the CICS bundle to z/OS
@@ -99,4 +99,4 @@ Alternatively, to define and install the BUNDLE but not enable it:
 
 ```console
 zowe cics-deploy deploy bundle --name Express --bundle-directory "/var/cicsts/bundles/myexpressapp_1.0.0" --target-state disabled
-```
+```

docs/pages/cdp/cdp-Troubleshooting-General.md renamed to docs/pages/cdp/cdp-Log-and-trace-files.md

@@ -2,17 +2,19 @@
 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 the z/OS machine."
+summary: "When you use Zowe, log and trace files are written on both your local workstation and z/OS."
 sidebar: cdp_sidebar
-permalink: cdp-Troubleshooting-General.html
+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.  
 
 ### zowe.log
-The .zowe directory on your local workstation contains log files, profiles, and plug-ins. The location of this directory can be customised as described in [ Setting the Zowe CLI home directory](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-the-zowe-cli-home-directory) and logging level set as described in [Setting Zowe CLI log levels](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-zowe-cli-log-levels).
+
+The .zowe directory on your local workstation contains log files, profiles, and plug-ins. The location of this directory can be customized as described in [Setting the Zowe CLI home directory](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-the-zowe-cli-home-directory) and logging level set as described in [Setting Zowe CLI log levels](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-zowe-cli-log-levels).
 
 You can use the following command to display messages written to the log file as they occur. This can be useful when troubleshooting problems when using `zowe` and `zowe cics-plugin` commands in another terminal.
 <ul id="profileTabs" class="nav nav-tabs">
@@ -22,25 +24,27 @@ You can use the following command to display messages written to the log file as
 </ul>
   <div class="tab-content">
 <div role="tabpanel" class="tab-pane active" id="windows">
-<p>On Windows, use the Powershell command 
+<p>On Windows, use the Powershell command:
 <br/><br/>
 <tt>Get-Content $env:USERPROFILE\.zowe\zowe\logs\zowe.log -Tail 30 -wait</tt></p>
 </div>
 
 <div role="tabpanel" class="tab-pane" id="linux">
-    <p>On Linux, use <tt>tail -f -n 0 ~/.zowe/zowe/logs/zowe.log</tt></p></div>
+    <p>On Linux, use command: <tt>tail -f -n 0 ~/.zowe/zowe/logs/zowe.log</tt></p></div>
 
 <div role="tabpanel" class="tab-pane" id="macos">
-    <p>On macOS, use <tt>tail -f -n 0 ~/.zowe/zowe/logs/zowe.log</tt></p>
+    <p>On macOS, use command: <tt>tail -f -n 0 ~/.zowe/zowe/logs/zowe.log</tt></p>
 </div>
 </div>
 
 ### Node.js logs
+
 By default, CICS writes Node.js log files on z/OS to the `/tmp` directory. However, the `generate bundle` command creates a number of files including `nodejsapps/<my app name>.profile` (often referred to as the Node.js profile), which you can edit to specify a more convenient log file location. Such logs get written to the directory referenced by the environment variable `WORK_DIR`. For example, you might edit your Node.js profile so that it includes the line:
 
-```
+```properties
 WORK_DIR=/u/<your user id>/nodelogs
 ```
+
 This causes CICS to write all Node.js logs to the specified directory.
 
 Files typically written to `WORK_DIR` include:
@@ -55,6 +59,7 @@ They can all be useful when identifying the cause of an error, especially STDERR
 {% include tip.html content="The `cics-deploy push` command outputs the full paths of STDOUT and STDERR after a deployment." %}
 
 ### 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.
 
-{% 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." %}
+{% 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." %}