Skip to content

Commit 017ee0d

Browse files
Merge pull request #58 from vera-chan/review-comments
take demetri's changes
2 parents a0f492b + 8a15e20 commit 017ee0d

File tree

7 files changed

+33
-104
lines changed

7 files changed

+33
-104
lines changed

docs/ansible_content.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,29 @@
22
.. © Copyright IBM Corporation 2020 .
33
.. ...........................................................................
44
5-
CICS Collection
6-
========================
5+
=========
6+
z/OS CICS
7+
=========
78

8-
The **IBM® z/OS® CICS® collection**, also represented as **ibm\_zos\_cics**
9-
in this document, is part of the broader initiative to bring Ansible® Automation to IBM Z® through the offering Red Hat® Ansible Certified Content for IBM Z®. It provides tasks to define, install, and perform actions on CICS definitions and resources such as creating a PROGRAM definition, installing and updating it, and deleting the definition.
9+
The **IBM® z/OS® CICS® collection**, also represented as
10+
ibm_zos_cics in this document, is part of the broader
11+
initiative to bring Ansible® Automation to IBM Z® through the offering
12+
**Red Hat® Ansible Certified Content for IBM Z**.
1013

11-
The CICS collection can work in conjunction with or independently from other IBM z/OS collections on Ansible such as the `IBM z/OS core collection`_. When used alone, it performs automation tasks solely in CICS. When using it together with other z/OS collections, you can achieve a more powerful solution for automating tasks on z/OS.
14+
The **IBM® z/OS® CICS® collection** supports automation tasks that can
15+
define, install, and perform actions on CICS definitions and resources such as
16+
creating a PROGRAM definition, installing and updating it, and deleting the
17+
definition.
1218

19+
The Ansible modules in this collection are written in Python and interact with
20+
the `CMCI REST API`_ of the CICS® management client interface (CMCI) for system
21+
management.
1322

14-
.. _IBM z/OS core collection:
15-
https://github.com/ansible-collections/ibm_zos_core
16-
23+
.. _CMCI REST API:
24+
https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/fundamentals/cpsm/cpsm-cmci-restfulapi-overview.html
1725

1826
.. toctree::
1927
:maxdepth: 1
20-
:caption: Reference
28+
:caption: Collection Content
2129

2230
source/modules

docs/source/community_guides.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.. Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0) .
44
.. ...............................................................................
55
6+
============
67
Contributing
78
============
89

docs/source/index.rst

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,6 @@ The IBM z/OS CICS collection includes `modules`_, `sample playbooks`_, and ansib
4141
.. _sample playbooks:
4242
https://github.com/ansible-collections/ibm_zos_cics/tree/master/playbooks/
4343

44-
Contributing
45-
============
46-
47-
Thank you for contributing to this project.
48-
49-
We welcome bug reports and discussions about new function in the issue tracker, and we also welcome proposed new features or bug fixes via pull requests.
50-
51-
For contribution guidelines, see `How to contribute`_.
52-
53-
.. _How to contribute:
54-
https://github.com/ansible-collections/ibm_zos_cics/tree/master/CONTRIBUTING.md
55-
56-
5744

5845
Copyright
5946
=========

docs/source/modules.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
Modules
77
=======
88

9-
Modules can be used in a playbook to automate tasks. Ansible® executes each module on the target node and returns the result back to the controller.
9+
Modules can be used in a playbook to automate tasks. Ansible® executes each
10+
module on the target node and returns the result back to the controller.
1011

11-
The **IBM® z/OS® CICS® collection** contains these modules. For each module, the accepted parameters, return values, and examples are provided in the documentation.
12+
The **IBM® z/OS® CICS® collection** contains these modules. For each module,
13+
the accepted parameters, return values, and examples are provided in the
14+
documentation.
1215

1316
.. toctree::
1417
:maxdepth: 1
1518
:glob:
1619

1720
modules/*
18-
19-
20-

docs/source/requirements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A control node is any machine with Ansible® installed. You can run commands and
3232
Managed node
3333
------------
3434

35-
The CMCI tasks in the IBM z/OS CICS collection interact with the managed node over an HTTP connection by leveraging the `CMCI REST API`_. Therefore, an SSH connection is not necessary. Instead, you can delegate the CMCI tasks to run on the control node directly, for example, by specifying ``delegate_to: 'localhost'`` for the tasks in the playbook. For detailed requirements, see :doc:`requirements_managed`.
35+
For detailed requirements, see :doc:`requirements_managed`.
3636

3737

3838
.. toctree::

docs/source/requirements_managed.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@
55
Requirements of managed nodes
66
=============================
77

8-
The CMCI tasks in the **IBM® z/OS® CICS® collection** interact with the managed node over an HTTP connection by leveraging the `CMCI REST API`_. Therefore, an SSH connection is not necessary. Instead, you can delegate Ansible tasks to run on the control node, for example, by specifying ``delegate_to: 'localhost'`` for the task in the playbook. For more ways of delegating tasks, see `Controlling where tasks run`_.
9-
10-
Delegating tasks to run on the control node saves you the complexity of configuring an unnecessary SSH connection and installing module dependencies on the remote host.
8+
The CMCI tasks in the **IBM® z/OS® CICS® collection** interact
9+
with the managed node over an HTTP connection by leveraging the `CMCI REST API`_.
10+
Therefore, an SSH connection is not required. Instead, you can delegate
11+
Ansible tasks to run on the control node, for example, by specifying
12+
``delegate_to: 'localhost'`` for the task in the playbook. In this case, you
13+
install dependencies on your localhost instead of the managed node.
14+
For more ways of delegating tasks, see `Controlling where tasks run`_.
1115

1216
The requirements of the managed node are as follows:
1317

@@ -18,7 +22,8 @@ The requirements of the managed node are as follows:
1822
* `requests`_
1923
* `xmltodict`_
2024

21-
If you delegate the tasks to run on your localhost, the Python module dependencies need to be installed on your localhost instead. You can install them from CLI:
25+
If you delegate the tasks to run on your localhost, the Python module dependencies
26+
need to be installed on your localhost instead. You can install them from CLI:
2227

2328
.. code-block:: sh
2429

docs/zos-collection-index.rst

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)