Skip to content

Commit cd19c11

Browse files
Beth-SimpsonBethany Simpson
andauthored
camel case and copyright in documentation read me
Co-authored-by: Bethany Simpson <[email protected]>
1 parent 9698a0c commit cd19c11

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ one easy-to-use platform.
2121

2222
The **IBM z/OS CICS collection** is following the
2323
**Red Hat® Ansible Certified Content for IBM Z®** method of distributing
24-
content. Collections will be developed in the open, and when content is ready
24+
content. Collections are developed in the open, and when content is ready
2525
for use it is released to
2626
[Ansible Galaxy](https://galaxy.ansible.com/search?keywords=zos_&order_by=-relevance&deprecated=false&type=collection&page=1)
2727
for community adoption. Once contributors review community usage, feedback,
@@ -68,7 +68,7 @@ collections:
6868
```
6969

7070

71-
To install a specific version of the collection or upgrade an an existing installation to a specific version, for example installing 2.1.0, use the following syntax:
71+
To install a specific version of the collection or upgrade an existing installation to a specific version, for example installing 2.1.0, use the following syntax:
7272
```sh
7373
ansible-galaxy collection install ibm.ibm_zos_cics:2.1.0
7474
```
@@ -99,53 +99,53 @@ environment_vars:
9999
LANG: "C"
100100
```
101101

102-
## Use Cases
102+
## Use cases
103103

104-
* Use Case Name: Provision a standalone CICS region
104+
* Use case name: Provision a standalone CICS region
105105
* Actors:
106106
* System Programmer
107107
* Description:
108108
* A system programmer can provision a set of region data sets and start up a standalone CICS region.
109109
* Flow:
110-
* Create and activate a VTAM node to ensure user had a valid applid
110+
* Create and activate a VTAM node to ensure user has a valid applid
111111
* Create region data sets
112112
* Update the CSD data set with a CSDUP script
113113
* Create CICS startup JCL data set
114-
* Submit the CICS startup JCL data set as a job using zoau's jsub.
115-
* Use Case Name: Deprovision a standalone CICS region
114+
* Submit the CICS startup JCL data set as a job using zoau's jsub
115+
* Use case name: Deprovision a standalone CICS region
116116
* Actors:
117117
* System Programmer
118118
* Description:
119-
* A system programmer can stop a standalone cics region and delete the region data sets.
119+
* A system programmer can stop a standalone CICS region and delete the region data sets.
120120
* Flow:
121121
* Stop the CICS region
122122
* Check the CICS region has been shut down
123123
* If it has not stopped, shut the region down with state "immediate" or cancel the job.
124124
* Delete the region data sets
125125
* Delete the CICS startup JCL data set
126-
* Use Case Name: Provision an SMSS CICS region
126+
* Use case name: Provision an SMSS CICS region
127127
* Actors:
128128
* System Programmer
129129
* Description:
130130
* A system programmer can start a SMSS CICS region.
131131
* Flow:
132-
* Create and activate a VTAM node to ensure user had a valid applid
132+
* Create and activate a VTAM node to ensure user has a valid applid
133133
* Ensure user has an allocated/free port available
134134
* Create region data sets
135135
* Update the CSD data with a CSDUP script which also alters the TCPIP service
136136
* Create CICS startup JCL data set
137137
* Submit the CICS startup JCL data set as a job using zoau's jsub task
138-
* Use Case Name: Install a bundle in a CICS region
138+
* Use case name: Install a bundle in a CICS region
139139
* Actors:
140140
* Application Developer
141141
* Description:
142142
* An application developer can install a CICS bundle into a CICS region
143143
* Flow:
144-
* Find if the CICS bundle already exists in target region
144+
* Find if the CICS bundle already exists in the target region
145145
* Disable and discard existing CICS bundle
146-
* Install bundle definition into target region
146+
* Install bundle definition into the target region
147147
* Wait for bundle to reach enabled status
148-
* Use Case Name: Deploy a program to a CICS region
148+
* Use case name: Deploy a program to a CICS region
149149
* Actors:
150150
* Application Developer
151151
* Description:
@@ -154,7 +154,7 @@ environment_vars:
154154
* Copy load module to load library
155155
* Use NEWCOPY PROGRAM to deploy program into CICS
156156

157-
## Release Notes and Roadmap
157+
## Release notes and roadmap
158158

159159
The collection's cumulative release notes can be reviewed [here](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html).
160160

@@ -168,9 +168,9 @@ The collection's cumulative release notes can be reviewed [here](https://ibm.git
168168
| 1.0.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html#version-1-0-6) | [Changelogs](https://github.com/ansible-collections/ibm_zos_cics/blob/v1.0.6/CHANGELOG.rst) |
169169

170170

171-
## Related Information
171+
## Related information
172172

173-
Example playbooks and use cases can be be found in the [z/OS playbook repository](https://github.com/IBM/z_ansible_collections_samples).
173+
Example playbooks and use cases can be found in the [z/OS playbook repository](https://github.com/IBM/z_ansible_collections_samples).
174174
Supplemental content on getting started with Ansible, architecture and use cases is available [here](https://ibm.github.io/z_ansible_collections_doc/reference/helpful_links.html).
175175

176176
## Contributing
@@ -179,7 +179,7 @@ We welcome contributions! Find out how in our [contribution guide](https://githu
179179

180180
## Copyright
181181

182-
© Copyright IBM Corporation 2021, 2024.
182+
© Copyright IBM Corporation 2021, 2025.
183183

184184
## License
185185

0 commit comments

Comments
 (0)