Skip to content

Commit 73187f0

Browse files
authored
Merge pull request #241 from tasha-m-k/master
Making wording more consistent.
2 parents 024c31d + e87976f commit 73187f0

8 files changed

+23
-23
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ This project welcomes all contributions.
77
- If you would like to contribute a bug fix or small enhancement, please fork the repo and make a pull request.
88
- If you would like to contribute a new feature, please raise an issue describing your proposal so we can discuss it first.
99

10-
## Developing Zowe CLI plugins
10+
## Developing Zowe CLI plug-ins
1111

1212
For guidelines on developing Zowe CLI plug-ins see the [Zowe CLI GitHub repository](https://github.com/zowe/zowe-cli). The following information is critical to working with the code, running/writing/maintaining automated tests, developing consistent syntax and ensuring that the plug-in integrates with Zowe CLI properly:
1313

1414
| For more information about ... | See: |
1515
| ------------------------------ | ----- |
16-
| General guidelines that apply to contributing to Zowe CLI and Plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) |
16+
| General guidelines that apply to contributing to Zowe CLI and plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) |
1717
| Conventions and best practices for creating packages and plug-ins for Zowe CLI | [Package and Plug-in Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PackagesAndPluginGuidelines.md)|
1818
| Guidelines for running tests on Zowe CLI | [Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/TESTING.md) |
1919
| Guidelines for running tests on the plug-ins that you build for Zowe CLI | [Plug-in Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PluginTESTINGGuidelines.md) |
2020
| Documentation that describes the features of the Imperative CLI Framework | [About Imperative CLI Framework](https://github.com/zowe/imperative/wiki) |
21-
Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) |
21+
Versioning conventions for Zowe CLI and plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) |

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The project was started in February 2019 and is at an early stage of development
77
To try it out, build the plug-in from source as described in [setup](docs-internal/tutorials/Setup.md).
88

99
## 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).
10+
You can find information and tutorials on using this plug-in in our [documentation](https://ibm.github.io/zowe-cli-cics-deploy-plugin/index.html).
1111

1212
## Contributing
1313
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/pages/cdp/cdp-Deploying-your-first-nodejs-app.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
1515

1616
### Procedure
1717

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

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

@@ -29,19 +29,19 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
2929
npm start
3030
```
3131

32-
The Node.js application will start. You can call the application from a browser using URL [http://localhost:3000/](http://localhost:3000/). To stop the application in the console press CTRL+C.
32+
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.
3333

3434
4. Package the Node.js application into a [CICS bundle](cdp-cics-bundles).
3535

36-
Make sure you are in the root directory of the application.
36+
Make sure that you are in the root directory of the application.
3737

3838
Replace the value for `--port` with one that is available for use by the CICS region on z/OS. This sets the PORT environment variable in the generated `.profile` file. Additional variables can be set by editing this file.
3939

4040
```console
4141
zowe cics-deploy generate bundle --port 3000 --overwrite
4242
```
4343

44-
The output will indicates the directories and files created to form a CICS bundle. For example:
44+
The output indicates the directories and files that are created to form a CICS bundle. For example:
4545

4646
<pre class="messageText">
4747
define : NODEJSAPP "myexpressapp" with startscript "./bin/www"
@@ -61,13 +61,13 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
6161

6262
A progress bar is shown with status messages as the CICS bundle is deployed and the application is started. This can take a few minutes. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Troubleshooting-General).
6363

64-
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 Node.js application is started.
64+
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 Node.js application is started.
6565

6666
6. Test the Node.js application.
6767

68-
You can call the application from a browser using URL [http://myzos:3000/](http://myzos:3000/), replacing _myzos_ with the host name of the z/OS system, and _3000_ with the port specified in step 4.
68+
You can call the application from a browser by using URL [http://myzos:3000/](http://myzos:3000/), replacing _myzos_ with the host name of the z/OS system, and _3000_ with the port specified in step 4.
6969

70-
If you make changes to the application you can redeploy it by repeating step 5.
70+
If you make changes to the application, you can redeploy it by repeating step 5.
7171

7272
### Results
7373

docs/pages/cdp/cdp-Home.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Zowe CLI CICS deploy plugin
2+
title: Zowe CLI CICS deploy plug-in
33
tags: [getting_started]
44
keywords:
5-
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)."
5+
summary: "The Zowe command line interface (CLI) provides a simple and streamlined way to interact with IBM z/OS. The cics-deploy plug-in extends the Zowe CLI to deploy applications developed on a workstation to IBM CICS Transaction Server for z/OS (CICS)."
66
sidebar: cdp_sidebar
77
permalink: index.html
88
folder: cdp
99
---
1010

1111
It provides a CICS deployment workflow for developers and CI/CD automation pipelines similar to that experienced when deploying applications to cloud environments.
1212

13-
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).
13+
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

1515
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

docs/pages/cdp/cdp-Installing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Installing
33
tags: [getting_started]
44
keywords:
5-
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."
5+
summary: "To install the Zowe CLI and cics-deploy plug-in, perform the following steps. For clarity, these components are installed on your local workstation, not on z/OS."
66
sidebar: cdp_sidebar
77
permalink: cdp-Installing.html
88
folder: cdp
@@ -18,13 +18,13 @@ toc: false
1818
npm --version
1919
```
2020

21-
2. Install [Zowe CLI](https://zowe.github.io/docs-site/latest/user-guide/cli-installcli.html). For example to install using npm:
21+
2. Install [Zowe CLI](https://zowe.github.io/docs-site/latest/user-guide/cli-installcli.html). For example, to install using npm:
2222

2323
```console
2424
sudo npm install -g @zowe/cli
2525
```
2626

27-
3. Build and install the cics-deploy plugin as described in [Setting up your development environment](https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/tutorials/Setup.md). For example:
27+
3. Build and install the cics-deploy plug-in as described in [Setting up your development environment](https://github.com/IBM/zowe-cli-cics-deploy-plugin/blob/master/docs-internal/tutorials/Setup.md). For example:
2828

2929
```console
3030
mkdir ~/cics-deploy
@@ -37,7 +37,7 @@ toc: false
3737
zowe plugins install .
3838
```
3939

40-
4. Verify the plugin is installed:
40+
4. Verify the plug-in is installed:
4141

4242
```console
4343
zowe plugins list

docs/pages/cdp/cdp-Requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Requirements on z/OS
33
tags: [getting_started, requirements]
44
keywords:
5-
summary: "The cics-deploy plugin is dependent on several servers and facilities that need to be set up on z/OS."
5+
summary: "The cics-deploy plug-in is dependent on several servers and facilities that need to be set up on z/OS."
66
sidebar: cdp_sidebar
77
permalink: cdp-Requirements.html
88
folder: cdp

docs/pages/cdp/cdp-Troubleshooting-General.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ folder: cdp
99
---
1010

1111
### Console output
12-
All Zowe CLI cics deploy plugin 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.
12+
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.
1313

1414
### zowe.log
1515
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).

docs/pages/cdp/cdp-zowe-and-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Zowe, the Zowe CLI and the cics-deploy plugin
2+
title: Zowe, the Zowe CLI and the cics-deploy plug-in
33
tags: [getting_started, concepts]
44
keywords:
55
summary: "Zowe is an open source framework that bridges the divide between workstation and mainframe computing."
@@ -26,5 +26,5 @@ It allows developers to interact with the mainframe via a command-line interface
2626

2727
The Zowe CLI is extended by creating and installing plug-ins.
2828

29-
### Zowe CLI CICS deploy plugin
30-
The Zowe CLI CICS deploy plugin extends the Zowe CLI to offer a command-line mechanism for Node.js developers to deploy workstation-developed applications into a running CICS Transaction Server for z/OS region on a remote mainframe. It's the quickest way to get a Node.js application from your workstation into a running CICS region without any special CICS knowledge.
29+
### Zowe CLI CICS deploy plug-in
30+
The Zowe CLI CICS deploy plug-in extends the Zowe CLI to offer a command-line mechanism for Node.js developers to deploy workstation-developed applications into a running CICS Transaction Server for z/OS region on a remote mainframe. It is the quickest way to get a Node.js application from your workstation into a running CICS region without any special CICS knowledge.

0 commit comments

Comments
 (0)