Merge pull request #162 from cxharris/master

Home page changes

Author: tasha-m-k

docs/_config.yml

@@ -16,9 +16,6 @@ company_name: IBM
 github_editme_path: 
 # if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
 
-path_to_generated_docs: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/
-# Location of the CLIReadme.md file that's generated when docs are built
-
 # gitlab_editme_path: tomjoht/documentation-theme-jekyll/tree/master
 # if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
 

docs/_data/sidebars/cdp_commads_sidebar.yml

@@ -58,33 +58,33 @@ entries:
     output: web
     folderitems:
     - title: create cics-deploy-profile
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#create--cre
+      url: cdp-CLIReadMe#create--cre
       output: web
     - title: update cics-deploy-profile
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#update--upd
+      url: cdp-CLIReadMe#update--upd
       output: web
     - title: delete cics-deploy-profile
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#delete--rm
+      url: cdp-CLIReadMe#delete--rm
       output: web
     - title: list cics-deploy-profile
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#list--ls
+      url: cdp-CLIReadMe#list--ls
       output: web
     - title: set-default cics-deploy-profile
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#set-default--set
+      url: cdp-CLIReadMe#set-default--set
       output: web
 
   - title: Commands - CICS deploy
     output: web
     folderitems:
     - title: generate bundle
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#module-generate
+      url: cdp-CLIReadMe#generate--g--gen
       output: web
     - title: push bundle
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#module-push
+      url: cdp-CLIReadMe#push--p
       output: web
     - title: deploy bundle
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#module-deploy
+      url: cdp-CLIReadMe#deploy--d--dep
       output: web
     - title: undeploy bundle
-      external_url: https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/CLIReadme.md#module-undeploy
+      url: cdp-CLIReadMe#undeploy--u--udep
       output: web

docs/_data/sidebars/cdp_sidebar.yml

@@ -960,6 +960,10 @@ a.no_icon:after
     margin-bottom: 10px;
 }
 
+.clipboardbutton {
+    display: block;
+    margin-left: 97%;
+}
 /* algolia search */
 
 .search {

docs/css/customstyles.css

@@ -36,7 +36,7 @@ $(document).ready(function () {
         $(this).attr('id', currentId);
 
         //trigger
-        var clipButton = '<button class="btn btn-primary btn-xs" data-clipboard-target="#' + currentId + '"><i class="fa fa-copy"></i></button>';
+        var clipButton = '<div class="clipboardbutton"><button class="btn btn-primary btn-xs" data-clipboard-target="#' + currentId + '"><i class="fa fa-copy"></i></button></div>';
         $(this).after(clipButton);
     });
 

docs/js/customscripts.js

@@ -1,28 +1,12 @@
-# Zowe CLI cics-deploy plugin command reference
-
-### Table of Contents
-* [cics-deploy](#module-cics-deploy)
-	* [deploy | d | dep](#module-deploy)
-		* [bundle](#command-bundle)
-	* [generate | g | gen](#module-generate)
-		* [bundle](#command-bundle)
-	* [push | p](#module-push)
-		* [bundle](#command-bundle)
-	* [undeploy | u | udep](#module-undeploy)
-		* [bundle](#command-bundle)
-* [profiles](#module-profiles)
-	* [create | cre](#module-create)
-		* [cics-deploy-profile](#command-cics-deploy-profile)
-	* [update | upd](#module-update)
-		* [cics-deploy-profile](#command-cics-deploy-profile)
-	* [delete | rm](#module-delete)
-		* [cics-deploy-profile](#command-cics-deploy-profile)
-	* [list | ls](#module-list)
-		* [cics-deploy-profiles](#command-cics-deploy-profiles)
-	* [set-default | set](#module-set-default)
-		* [cics-deploy-profile](#command-cics-deploy-profile)
-
-
+---
+title: Zowe CLI cics-deploy plugin command reference
+keywords:
+summary: "This section contains syntax reference information for the Zowe CLI CICS deploy plugin"
+sidebar: cdp_sidebar
+permalink: cdp-CLIReadMe.html
+folder: cdp
+toc: true
+---
 # cics-deploy<a name="module-cics-deploy"></a>
 Generate and deploy IBM CICS bundle resources
 ## deploy | d | dep<a name="module-deploy"></a>

docs-internal/CLIReadme.md renamed to docs/pages/cdp/CLIReadme.md

@@ -2,19 +2,21 @@
 title: Zowe CLI CICS deploy plugin
 tags: [getting_started]
 keywords:
-summary: "The Zowe command line interface (CLI) provides a simple and streamlined way to interact with IBM z/OS. The cics-deploy plugin extends the Zowe CLI to deploy applications developed on a workstation to IBM CICS Transaction Server for z/OS (CICS)."
+summary: "The Zowe command line interface (CLI) provides a simple and streamlined way to interact with IBM z/OS. The cics-deploy plugin extends the Zowe CLI to deploy Node.js applications developed on a workstation to IBM CICS Transaction Server for z/OS (CICS)."
 sidebar: cdp_sidebar
 permalink: index.html
 folder: cdp
 ---
 
-It aims to provide an experience for developers and CI/CD automation pipelines similar to deploying to a cloud platform when deploying to CICS.
+It provides a Node.js CICS deployment workflow for developers and CI/CD automation pipelines similar to that experienced when deploying Node.js applications to the cloud.
 
-The plug-in provides the following commands:
-* [zowe cics-deploy generate bundle]({{ site.path_to_generated_docs }}CLIReadme.md#module-generate) - Generate a CICS bundle in the working directory. Typically used by developers to package their existing application as a CICS bundle.
+Before you start, and especially if you are not familiar with the world of z/OS, Zowe and CICS, it's a good idea to read about some of the key concepts, which include [Zowe](cdp-zowe-and-cli), [Zowe CLI profiles](cdp-zowe-profiles) and [CICS bundles](cdp-cics-bundles). If you're keen to get going quickly, you can jump right in and follow along with our tutorial on [Deploying your first app](cdp-Deploying-your-first-app).
 
-* [zowe cics-deploy push bundle]({{ site.path_to_generated_docs }}CLIReadme.md#module-push) - Firstly undeploy the previous version of the CICS bundle from CICS incase it had been previously deployed. Then copy the bundle from the working directory to a z/OS directory, and run npm to install dependencies for each Node.js application in the bundle. Finally deploy the bundle to one or more CICS regions within a CICSplex. Typically used by developers to deploy applications in CICS ready for testing.
+When everything has been [installed](cdp-Installation) and [you've created the Zowe CLI profiles](cdp-Create-Zowe-CLI-profiles), you can deploy a Node.js application from your workstation to CICS in two steps:
 
-* [zowe cics-deploy deploy bundle]({{ site.path_to_generated_docs }}CLIReadme.md#module-deploy) - Deploy a CICS bundle that is in a z/OS directory to one more CICS regions within a CICSplex. The DFHDPLOY utility is used to define the BUNDLE resource in a CICS system definition (CSD) file or CPSM Business Application Services (BAS) file, then install and enable the resource in the target CICS regions. Typically used by developers and CI-CD pipelines that require more precise control when deploying applications to CICS, for example to install the bundle in subsets of CICS regions in a cluster in a manner that maintains the availability of the application for clients.
+1. Use the [zowe cics-deploy generate bundle](cdp-CLIReadMe#generate--g--gen) command to generate some metadata and artifacts that help the target CICS system understand your application.
+1. Use the [zowe cics-deploy push bundle](cdp-CLIReadMe#push--p) command to push the generated bundle to one or more regions within a CICSplex, enabling and deploying it as an executing application. 
 
-* [zowe cics-deploy undeploy bundle]({{ site.path_to_generated_docs }}CLIReadme.md#module-undeploy) - Undeploy a CICS bundle from one or more CICS regions within a CICSplex. The DFHDPLOY utility is used to disable then discard the BUNDLE resource from the target CICS regions, then the resource is deleted from a CICS CSD or CPSM BAS file. Typically used by developers and CI-CD pipelines that require more precise control when undeploying applications to CICS.
+Should you need it, and if you understand a little more about CICS, further commands like [zowe cics-deploy deploy bundle](cdp-CLIReadMe#deploy--d--dep) and [zowe cics-deploy undeploy bundle](cdp-CLIReadMe#undeploy--u--udep) offer you finer-grained control of the process - for example, to enable you to install a bundle in subsets of CICS regions in a cluster in such a way as to maintain an application's availability for clients.
+
+If you hit any speed bumps on your journey, check out our [Troubleshooting](cdp-Troubleshooting-General) pages.

docs/pages/cdp/cdp-Home.md

@@ -24,6 +24,16 @@ const DISPLAY_NAME = "Zowe CLI";
 
 const BINARY_NAME = "zowe";
 
+const JEKYLL_FRONTMATTER = `---
+title: Zowe CLI cics-deploy plugin command reference
+keywords:
+summary: "This section contains syntax reference information for the Zowe CLI CICS deploy plugin"
+sidebar: cdp_sidebar
+permalink: cdp-CLIReadMe.html
+folder: cdp
+toc: true
+---\n`
+
 const doc: ITaskFunction = async () => {
     process.env.FORCE_COLOR = "0";
 
@@ -41,10 +51,12 @@ const doc: ITaskFunction = async () => {
     clearRequire.all(); // in case the code has changed, reload any code
 
     let totalCommands = 0;
-    let markdownContent = "# Zowe CLI cics-deploy plugin command reference\n\n";
+    //let markdownContent = "# Zowe CLI cics-deploy plugin command reference\n\n";
+    let markdownContent = '';
 
-    markdownContent += "{{tableOfContents}}\n\n";
+    //markdownContent += "{{tableOfContents}}\n\n";
     let tableOfContentsText = "### Table of Contents\n";
+    //let tableOfContentsText = '';
 
     const tabIndent = "\t";
     let oldCommandName = "";
@@ -70,8 +82,9 @@ const doc: ITaskFunction = async () => {
     getGroupHelp(profilesGroup);
 
     markdownContent = mustache.render(markdownContent, {tableOfContents: tableOfContentsText});
-    fs.writeFileSync("docs-internal/CLIReadme.md", markdownContent);
-    gutil.log(gutil.colors.blue("Updated docs-internal/CLIReadme.md with definitions of " + totalCommands + " commands"));
+
+    fs.writeFileSync("docs/pages/cdp/CLIReadme.md", JEKYLL_FRONTMATTER + markdownContent);
+    gutil.log(gutil.colors.blue("Updated docs/pages/CLIReadme.md with definitions of " + totalCommands + " commands"));
 
     process.env.FORCE_COLOR = undefined;
 
@@ -103,7 +116,7 @@ const doc: ITaskFunction = async () => {
         }
 
         const anchorTag = "module-" + definition.name;
-        tableOfContentsText += util.format("%s* [%s](#%s)\n", tabIndent.repeat(indentLevel), commandNameSummary, anchorTag);
+        tableOfContentsText += util.format("%s* [%s](#%s)", tabIndent.repeat(indentLevel), commandNameSummary, anchorTag);
 
         markdownContent += util.format("#%s %s<a name=\"%s\"></a>\n", "#".repeat(indentLevel), commandNameSummary, anchorTag);
         markdownContent += definition.description ? definition.description.trim() + "\n" : "";
@@ -121,7 +134,7 @@ const doc: ITaskFunction = async () => {
                 childNameSummary += " (experimental)";
             }
 
-            tableOfContentsText += util.format("%s* [%s](#%s)\n", tabIndent.repeat(indentLevel + 1), childNameSummary, childAnchorTag);
+            tableOfContentsText += util.format("%s* [%s](#%s)", tabIndent.repeat(indentLevel + 1), childNameSummary, childAnchorTag);
             markdownContent += util.format("##%s %s<a name=\"%s\"></a>\n", "#".repeat(indentLevel), childNameSummary, childAnchorTag);
 
             const helpGen = new DefaultHelpGenerator({