You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@ This project welcomes all contributions.
7
7
- If you would like to contribute a bug fix or small enhancement, please fork the repo and make a pull request.
8
8
- If you would like to contribute a new feature, please raise an issue describing your proposal so we can discuss it first.
9
9
10
-
## Developing Zowe CLI plugins
10
+
## Developing Zowe CLI plug-ins
11
11
12
12
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:
13
13
14
14
| For more information about ... | See: |
15
15
| ------------------------------ | ----- |
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)|
17
17
| 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)|
18
18
| Guidelines for running tests on Zowe CLI |[Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/TESTING.md)|
19
19
| 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)|
20
20
| 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) |
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ The project was started in February 2019 and is at an early stage of development
7
7
To try it out, build the plug-in from source as described in [setup](docs-internal/tutorials/Setup.md).
8
8
9
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).
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).
11
11
12
12
## Contributing
13
13
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.
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-Deploying-your-first-nodejs-app.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
15
15
16
16
### Procedure
17
17
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).
19
19
20
20
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).
21
21
@@ -29,19 +29,19 @@ CICS TS V5.5 introduced support to run Node.js applications and is required by t
29
29
npm start
30
30
```
31
31
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.
33
33
34
34
4. Package the Node.js application into a [CICS bundle](cdp-cics-bundles).
35
35
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.
37
37
38
38
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.
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:
45
45
46
46
<preclass="messageText">
47
47
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
61
61
62
62
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).
63
63
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.
65
65
66
66
6. Test the Node.js application.
67
67
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.
69
69
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.
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-Home.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
---
2
-
title: Zowe CLI CICS deploy plugin
2
+
title: Zowe CLI CICS deploy plug-in
3
3
tags: [getting_started]
4
4
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)."
6
6
sidebar: cdp_sidebar
7
7
permalink: index.html
8
8
folder: cdp
9
9
---
10
10
11
11
It provides a CICS deployment workflow for developers and CI/CD automation pipelines similar to that experienced when deploying applications to cloud environments.
12
12
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).
14
14
15
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:
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-Installing.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Installing
3
3
tags: [getting_started]
4
4
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."
6
6
sidebar: cdp_sidebar
7
7
permalink: cdp-Installing.html
8
8
folder: cdp
@@ -18,13 +18,13 @@ toc: false
18
18
npm --version
19
19
```
20
20
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:
22
22
23
23
```console
24
24
sudo npm install -g @zowe/cli
25
25
```
26
26
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:
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-Troubleshooting-General.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ folder: cdp
9
9
---
10
10
11
11
### 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.
13
13
14
14
### zowe.log
15
15
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).
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-zowe-and-cli.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Zowe, the Zowe CLI and the cics-deploy plugin
2
+
title: Zowe, the Zowe CLI and the cics-deploy plug-in
3
3
tags: [getting_started, concepts]
4
4
keywords:
5
5
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
26
26
27
27
The Zowe CLI is extended by creating and installing plug-ins.
28
28
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