Skip to content

Commit da42ead

Browse files
authored
Merge pull request #226 from tasha-m-k/master
Updated readme and made titles consistent
2 parents 2ba97ef + fc42f50 commit da42ead

8 files changed

+20
-17
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,8 @@ The project was started in February 2019 and is at an early stage of development
66

77
To try it out, build the plug-in from source as described in [setup](docs-internal/tutorials/Setup.md).
88

9+
## Documentation
10+
You can find information and tutorials on using this plugin in our [documentation](https://ibm.github.io/zowe-cli-cics-deploy-plugin/index.html).
11+
912
## Contributing
1013
Contributions are welcome - see the [contribution guidelines](CONTRIBUTING.md). If you have a question or encounter a problem please raise an issue in this repo.

docs/_data/sidebars/cdp_sidebar.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ entries:
1515
- title: Requirements on z/OS
1616
url: cdp-Requirements.html
1717
output: web
18-
- title: Installation
19-
url: cdp-Installation.html
18+
- title: Installing
19+
url: cdp-Installing.html
2020
output: web
21-
- title: Create Zowe CLI profiles
22-
url: cdp-Create-Zowe-CLI-profiles.html
21+
- title: Creating Zowe CLI profiles
22+
url: cdp-Creating-Zowe-CLI-profiles.html
2323
output: web
2424

2525
- title: Tutorials
@@ -32,8 +32,8 @@ entries:
3232
- title: Deploying using individual actions
3333
url: cdp-Deploying-using-individual-actions.html
3434
output: web
35-
- title: Provision a CICS region with z/OS PT
36-
url: cdp-Provision-a-CICS-region-using-zospt.html
35+
- title: Provisioning a CICS region with z/OS PT
36+
url: cdp-Provisioning-a-CICS-region-using-zospt.html
3737
output: web
3838

3939
- title: Concepts

docs/pages/cdp/cdp-Create-Zowe-CLI-profiles.md renamed to docs/pages/cdp/cdp-Creating-Zowe-CLI-profiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Create Zowe CLI profiles
2+
title: Creating Zowe CLI profiles
33
tags: [getting_started, concepts]
44
keywords:
55
summary: "Zowe profiles let you store configuration details so you don't have to repeat them every time you use a Zowe CLI command."
66
sidebar: cdp_sidebar
7-
permalink: cdp-Create-Zowe-CLI-profiles.html
7+
permalink: cdp-Creating-Zowe-CLI-profiles.html
88
folder: cdp
99
---
1010

docs/pages/cdp/cdp-Deploying-your-first-nodejs-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ toc: true
1111

1212
### Before you begin
1313

14-
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 [Provision a CICS region using z/OS PT](cdp-Provision-a-CICS-region-using-zospt) to provision one, or speak to your CICS system administrator.
14+
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.
1515

1616
### Procedure
1717

18-
1. Install the Zowe CLI and cics-deploy plugin by following the steps in [Installation](cdp-Installation).
18+
1. Install the Zowe CLI and cics-deploy plugin by following the steps in [Installing](cdp-Installing).
1919

20-
2. Create Zowe CLI profiles for z/OSMF, SSH, and cics-deploy by following the steps in [Create Zowe CLI profiles](cdp-Create-Zowe-CLI-profiles).
20+
2. Create Zowe CLI profiles for z/OSMF, SSH, and cics-deploy by following the steps in [Creating Zowe CLI profiles](cdp-Creating-Zowe-CLI-profiles).
2121

2222
3. Create a Node.js application using the [Express Application Generator](https://expressjs.com/en/starter/generator.html):
2323

docs/pages/cdp/cdp-Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It provides a CICS deployment workflow for developers and CI/CD automation pipel
1212

1313
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 Node.js app](cdp-Deploying-your-first-nodejs-app).
1414

15-
When everything is [installed](cdp-Installation) and you have [created the Zowe CLI profiles](cdp-Create-Zowe-CLI-profiles), you can deploy an application from your workstation to CICS in two steps:
15+
When everything is [installed](cdp-Installing) and you have [created the Zowe CLI profiles](cdp-Creating-Zowe-CLI-profiles), you can deploy an application from your workstation to CICS in two steps:
1616

1717
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.
1818

docs/pages/cdp/cdp-Installation.md renamed to docs/pages/cdp/cdp-Installing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Installation
2+
title: Installing
33
tags: [getting_started]
44
keywords:
55
summary: "To install the Zowe CLI and cics-deploy plugin, perform the following steps. For clarity, these components are installed on your local workstation, not on z/OS."
66
sidebar: cdp_sidebar
7-
permalink: cdp-Installation.html
7+
permalink: cdp-Installing.html
88
folder: cdp
99
toc: false
1010
---

docs/pages/cdp/cdp-Provision-a-CICS-region-using-zospt.md renamed to docs/pages/cdp/cdp-Provisioning-a-CICS-region-using-zospt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Provision a CICS region using z/OS PT
2+
title: Provisioning a CICS region using z/OS PT
33
tags: [tutorial]
44
keywords:
55
summary: "The following steps take you through preparing a z/OS Provisioning Toolkit image for CICS, provisioning a CICS region using the image, and then starting, stopping and deprovisioning it."
66
sidebar: cdp_sidebar
7-
permalink: cdp-Provision-a-CICS-region-using-zospt.html
7+
permalink: cdp-Provisioning-a-CICS-region-using-zospt.html
88
folder: cdp
99
toc: true
1010
---

docs/pages/cdp/cdp-zowe-profiles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ zowe push bundle --name EXAMPLE --target-directory /u/example/bundles --zosmf-pr
3535
```
3636
This is a much more economical and concise command-line than if were it necessary to enumerate all of the individual arguments from all of the profiles.
3737

38-
As suggested above, to deploy a Node.js application from your workstation to one or more CICS regions, you will need to set up a minimum of three Zowe CLI profiles (optionally more if you wish to, say, deploy to multiple hosts) - you can read how to do it in detail [here](cdp-Create-Zowe-CLI-profiles).
38+
As suggested above, to deploy a Node.js application from your workstation to one or more CICS regions, you will need to set up a minimum of three Zowe CLI profiles (optionally more if you wish to, say, deploy to multiple hosts) - you can read how to do it in detail [here](cdp-Creating-Zowe-CLI-profiles).
3939

4040
{% include tip.html content="For each profile type, the first profile you create becomes the default for that type. In many cases, you don't even have to type in the name of a specific profile if you know that the default profile will serve your needs." %}
4141

0 commit comments

Comments
 (0)