Skip to content

Commit 65b8cab

Browse files
Merge branch 'dev' into xmlparser
2 parents c516548 + a2622c5 commit 65b8cab

12 files changed

+127
-54
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/_includes/head.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616
<!-- most color styles are extracted out to here -->
1717
<link rel="stylesheet" href="css/theme-blue.css">
1818

19+
<!-- Added by C Harris on 5th June 2019 -->
20+
<style>
21+
@import url('https://fonts.googleapis.com/css?family=IBM+Plex+Sans&display=swap');
22+
@import url('https://fonts.googleapis.com/css?family=IBM+Plex+Mono&display=swap');
23+
</style>
24+
1925
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
2026

2127
<!-- Added by C Harris on 1st May 2019 - used for code copying buttons -->

docs/css/customstyles.css

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
body {
2+
font-family: 'IBM Plex Sans', sans-serif;
23
font-size:15px;
34
}
45

6+
pre {
7+
font-family: 'IBM Plex Mono', 'Courier New', Courier, monospace;
8+
}
9+
10+
code {
11+
font-family: 'IBM Plex Mono', 'Courier New', Courier, monospace;
12+
}
13+
514
.bs-callout {
615
padding: 20px;
716
margin: 20px 0;
@@ -429,7 +438,7 @@ ul#mysidebar {
429438
}
430439

431440
span.projectTitle {
432-
font-family: Helvetica;
441+
font-family: 'IBM Plex Sans', sans-serif;
433442
font-weight: bold;
434443
}
435444

@@ -820,7 +829,7 @@ a.accordion-toggle {
820829

821830
span.red {
822831
color: red;
823-
font-family: Monaco, Menlo, Consolas, "Courier New", monospace;
832+
font-family: 'IBM Plex Mono', Monaco, Menlo, Consolas, "Courier New", monospace;
824833
}
825834

826835
h3.codeExplanation {

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

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ permalink: cdp-Creating-Zowe-CLI-profiles.html
88
folder: cdp
99
---
1010

11-
### Step 1: Create a z/OSMF profile
11+
### Create a z/OSMF profile
1212

13-
This profile defines the parameters needed to connect to the z/OSMF server on z/OS. You need to know the following from your z/OS system administrator:
13+
The z/OSMF profile defines the parameters needed to connect to the z/OSMF server on z/OS. You need to know the following from your z/OS system administrator:
1414

1515
| Option | Description |
1616
| --- | --- |
@@ -39,9 +39,9 @@ To test the connection to the z/OSMF server using the profile:
3939
zowe zosmf check status
4040
```
4141

42-
### Step 2: Create an SSH profile
42+
### Create an SSH profile
4343

44-
This profile defines the parameters needed to connect to the SSH server on z/OS. You need to know the following from your z/OS system administrator:
44+
The SSH profile defines the parameters needed to connect to the SSH server on z/OS. You need to know the following from your z/OS system administrator:
4545

4646
| Option | Description |
4747
| --- | --- |
@@ -70,9 +70,9 @@ To test the connection to the SSH server using the profile:
7070
zowe zos-uss issue ssh 'uname -a'
7171
```
7272

73-
### Step 3: Create a cics-deploy profile
73+
### Create a cics-deploy profile
7474

75-
This profile identifies the CICS environment for deployment. You need to know the following from your CICS system administrator:
75+
The cics-deploy profile identifies the CICS environment for deployment. An example of how to create an environment using using z/OS Provisioning Toolkit as described in [Provisioning a CICS region using z/OS PT](cdp-Provisioning-a-CICS-region-using-zospt). You need to know the following from your CICS system administrator:
7676

7777
| Option | Description |
7878
| --- | --- |
@@ -96,4 +96,35 @@ For help on using the options:
9696
zowe profiles create cics-deploy-profile --help
9797
```
9898

99-
To test the cics-deploy profile, follow the steps in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).
99+
To test the cics-deploy profile, follow the steps in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).
100+
101+
### Create a CICS profile
102+
103+
The CICS profile identifies the connection to the CICS Web User Interface (WUI) server to query application resources. You need to know the following from your CICS system administrator:
104+
105+
| Option | Description |
106+
| --- | --- |
107+
| cics-plex | CPSM CICSplex name. This will typically be set to the same as cicsplex in the cics-deploy profile. |
108+
| protocol | HTTP or HTTPS to use to connect to the CICS WUI server. |
109+
| host | Host name of the CICS WUI server. |
110+
| port | Port number of the CICS WUI server. |
111+
| user | User ID to identify yourself to the CICS WUI server . |
112+
| password | Password to identify yourself to the CICS WUI server. |
113+
114+
For example, to create an SSH profile:
115+
116+
```console
117+
zowe profiles create cics-profile cics --cics-plex PLEX1 --protocol https --host myzos.example.com --port 1490 --user myuserid --password mypassword --overwrite
118+
```
119+
120+
For help on using the options:
121+
122+
```console
123+
zowe profiles create cics-profile --help
124+
```
125+
126+
To test the connection to the CICS WUI server using the profile:
127+
128+
```console
129+
zowe cics get resource CICSRegion
130+
```

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ 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

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).
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).
2121

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

@@ -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

0 commit comments

Comments
 (0)