Merge pull request #62 from stewartfrancis/review-updates

Fix a batch of review comments, more to come.

Author: sophiegreen

README.md

@@ -2,22 +2,41 @@ IBM z/OS CICS collection
 ========================
 
 The **IBM® z/OS® CICS® collection**, also represented as **ibm\_zos\_cics**
-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**. The IBM z/OS CICS collection supports management of CICS resources and definitions via the CMCI REST API provided by CICS.
+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®**. The **IBM z/OS CICS collection** supports management of CICS
+resources and definitions via the CMCI REST API provided by CICS.
 
-This 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](https://github.com/ansible-collections/ibm_zos_core). 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.
+This CICS collection works in conjunction with other Ansible collections for IBM Z,
+such as the [IBM z/OS core collection](https://github.com/ansible-collections/ibm_zos_core).
+It is also possible to use it independently to perform automation tasks solely in CICS.
 
 
 Red Hat Ansible Certified Content for IBM Z
 ===========================================
 
-**Red Hat Ansible Certified Content for IBM Z** provides the ability to connect IBM Z to clients\' wider enterprise automation strategy through the Ansible Automation Platform ecosystem. This enables development and operations automation on Z through a seamless, unified workflow orchestration with configuration management, provisioning, and application deployment in one easy-to-use platform.
+**Red Hat® Ansible Certified Content for IBM Z** provides the ability to
+connect IBM Z® to clients' wider enterprise automation strategy through the
+Ansible Automation Platform ecosystem. This enables development and operations
+automation on Z through a seamless, unified workflow orchestration with
+configuration management, provisioning, and application deployment in
+one easy-to-use platform.
 
-The **The IBM z/OS CICS collection** is following the **Red Hat Ansible Certified Content for IBM Z** method of distributing content. Collections will be developed in the open, and when content is ready for use it is released to [Ansible Galaxy](https://galaxy.ansible.com/search?keywords=zos_&order_by=-relevance&deprecated=false&type=collection&page=1) for community adoption. Once contributors review community usage, feedback, and are satisfied with the content published, the collection will then be released to [Ansible Automation Hub](https://www.ansible.com/products/automation-hub) as certified and IBM supported for Red Hat Ansible Automation Platform subscribers. 
+The **IBM z/OS CICS collection** is following the
+**Red Hat® Ansible Certified Content for IBM Z®** method of distributing
+content. Collections will be developed in the open, and when content is ready
+for use it is released to
+[Ansible Galaxy](https://galaxy.ansible.com/search?keywords=zos_&order_by=-relevance&deprecated=false&type=collection&page=1)
+for community adoption. Once contributors review community usage, feedback,
+and are satisfied with the content published, the collection will then be
+released to [Ansible Automation Hub](https://www.ansible.com/products/automation-hub)
+as **certified** and **IBM supported** for
+**Red Hat® Ansible Automation Platform subscribers**. 
 
-For **guides** and **reference**, please visit [the documentation site](https://ansible-collections.github.io/ibm_zos_cics/).
+
+For guides and reference, please review the {[documentation](https://ibm.github.io/z_ansible_collections_doc/index.html)
 
 Features
-================
+========
 
 The IBM CICS collection includes
 [modules](https://github.com/ansible-collections/ibm_zos_cics/tree/master/plugins/modules/),
@@ -27,14 +46,9 @@ and ansible-doc to automate tasks in CICS.
 
 Copyright
 =========
-
-© Copyright IBM Corporation 2020
+© Copyright IBM Corporation 2021.
 
 License
 =======
-
-This collection is licensed under [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
-
-
-
-
+This collection is licensed under [Apache License,
+Version 2.0](https://opensource.org/licenses/Apache-2.0).

CONTRIBUTING.md renamed to devguide.md

@@ -1,21 +1,5 @@
 # Developer guide
 
-## Reporting a bug
-
-Please raise bugs via the issue tracker. First, check whether an issue for your problem already exists.
-
-When raising bugs, try to give a good indication of the exact circumstances that provoked the bug. What were you doing? What did you expect to happen? What actually happened? What logs or other material can you provide to show the problem?
-
-## Requesting new features
-
-Please request new features via the issue tracker. When requesting features, try to show why you want the feature you're requesting.
-
-## Contributing code
-
-### Before you start...
-
-If you're thinking of fixing a bug or adding new features, be sure to open an issue first. This gives us a place to have a discussion about the work.
-
 ### Licensing
 
 All code must have an Apache-2.0 header.
@@ -77,8 +61,8 @@ To save you having to type the above for every commit, Git can add the `Signed-o
 
 If you haven't signed each commit, then the pull request will fail to pass all checks.
 
-Development Environment Set-Up Instructions
-===================
+# Development Environment Set-Up Instructions
+=============================================
 
 This repository contains an Ansible collection, which is tested using `ansible-test`.  This combination of development
 tooling requires you to clone the repository to a pretty specific path.  As an example, clone the repository to:

docs/Makefile

@@ -32,7 +32,7 @@ ibm_zos_cics:
 	mkdir build
 	mkdir -p source/modules
 	# mv ../plugins/modules/__init__.py ../plugins/modules/__init__.py.skip
-	ansible-doc-extractor --template templates/module.rst.j2 source/modules ../plugins/modules/*.py
+	python ansible-doc-extractor-collections.py
 	echo "Completed restructured text generation, run 'make html'"
 	# mv ../plugins/modules/__init__.py.skip ../plugins/modules/__init__.py
 view:

docs/source/modules/cmci_action.rst

@@ -8,8 +8,8 @@
 .. _cmci_action_module:
 
 
-cmci_action -- Install CICS and CICSPlex SM definitions
-=======================================================
+cmci_action -- Perform actions on CICS and CICSPlex SM resources
+================================================================
 
 
 
@@ -191,7 +191,7 @@ resources
 
     When supplying the ``attribute`` option, you must also supply a ``value`` for the filter.  You can also override the default operator with the ``=`` option.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
 
     | **required**: False
@@ -269,7 +269,7 @@ resources
 
     To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with ``and`` and ``or`` operators, see the ``complex_filter`` parameter.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
     For more details, see `How to build a filter expression <https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/system-programming/cpsm/eyup1a0.html>`_.
 

docs/source/modules/cmci_delete.rst

@@ -151,7 +151,7 @@ resources
 
     When supplying the ``attribute`` option, you must also supply a ``value`` for the filter.  You can also override the default operator with the ``=`` option.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
 
     | **required**: False
@@ -229,7 +229,7 @@ resources
 
     To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with ``and`` and ``or`` operators, see the ``complex_filter`` parameter.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
     For more details, see `How to build a filter expression <https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/system-programming/cpsm/eyup1a0.html>`_.
 

docs/source/modules/cmci_get.rst

@@ -8,8 +8,8 @@
 .. _cmci_get_module:
 
 
-cmci_get -- Query CICS and CICSPlex SM resources
-================================================
+cmci_get -- Query CICS and CICSPlex SM resources and definitions
+================================================================
 
 
 
@@ -164,7 +164,7 @@ resources
 
     When supplying the ``attribute`` option, you must also supply a ``value`` for the filter.  You can also override the default operator with the ``=`` option.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
 
     | **required**: False
@@ -242,7 +242,7 @@ resources
 
     To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with ``and`` and ``or`` operators, see the ``complex_filter`` parameter.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
     For more details, see `How to build a filter expression <https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/system-programming/cpsm/eyup1a0.html>`_.
 

docs/source/modules/cmci_update.rst

@@ -160,7 +160,7 @@ resources
 
     When supplying the ``attribute`` option, you must also supply a ``value`` for the filter.  You can also override the default operator with the ``=`` option.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
 
     | **required**: False
@@ -238,7 +238,7 @@ resources
 
     To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with ``and`` and ``or`` operators, see the ``complex_filter`` parameter.
 
-    For examples, see :ref:`ibm.ibm_zos_cics.cmci_get <ibm.ibm_zos_cics.cmci_get_module>`
+    For examples, see :ref:`cmci_get <cmci_get_module>`
 
     For more details, see `How to build a filter expression <https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/system-programming/cpsm/eyup1a0.html>`_.
 

galaxy.yml

@@ -5,7 +5,7 @@ namespace: ibm
 name: ibm_zos_cics
 
 # The collection version
-version: 1.0.0
+version: 0.0.1
 
 # Collection README file
 readme: README.md
@@ -22,7 +22,7 @@ description: The Red Hat Ansible Certified Content for IBM Z CICS collection inc
 license: L(Apache License, Version 2.0, https://spdx.org/licenses/Apache-2.0.html)
 
 # Tags
-tags: [ibm, z, zos, z_os, cics, red_hat_ansible_certified_cotent_for_ibm_z, cmci]
+tags: [ibm, z, zos, z_os, cics, cmci]
 
 # Collections that this collection requires to be installed for it to be usable.
 # dependencies: {} # This collection depends on no other collections
@@ -31,10 +31,10 @@ tags: [ibm, z, zos, z_os, cics, red_hat_ansible_certified_cotent_for_ibm_z, cmci
 repository: https://github.com/ansible-collections/ibm_zos_cics
 
 # The URL to any online docs
-documentation: https://github.com/ansible-collections/ibm_zos_cics/wiki 
+documentation: https://ibm.github.io/z_ansible_collections_doc
 
 # The URL to the homepage of the collection/project
-# homepage: https://www.ibm.com/it-infrastructure/z/
+homepage: https://www.ibm.com/support/z-content-solutions/ansible/
 
 # The URL to the collection issue tracker
 issues: https://github.com/ansible-collections/ibm_zos_cics/issues