Merge pull request ansible-collections#155 from cssh/erik-edits-feb-2024

Erik edits feb 2024

Author: ledina

docs/source/installation.rst

@@ -5,14 +5,14 @@
 
 Installation
 ============
-Always check that your control node has fulfilled the :doc:`requirements` before installing the **IBM® z/OS® CICS® collection**.
+Always check that your control node has met the :doc:`requirements` before you install the **IBM® z/OS® CICS® collection**.
 
-Then, follow the guidance to install the collection from Ansible® Galaxy or a custom Galaxy server. More ways to install an Ansible collection are documented at `installing collections`_.
+Then, follow the guidance to install the collection from Ansible® Galaxy or from a custom Galaxy server. More ways to install an Ansible collection are documented in `Installing collections`_.
 
 
 Installing from Ansible Galaxy
 ------------------------------
-This is the quickest way to install the CICS collection. From your CLI, enter:
+This is the quickest way to install the CICS collection. From your CLI, enter the following command:
 
 .. code-block:: sh
 
@@ -38,7 +38,7 @@ By default, collections are installed in ``~/.ansible/collections``. After insta
 
 
 
-To install with customization, such as specifying another installation path or using a playbook, see `installing collections`_.
+To install with customization, such as specifying another installation path or using a playbook, see `Installing collections`_.
 
 .. _installing collections:
    https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-collections-with-ansible-galaxy
@@ -57,7 +57,7 @@ Ansible searches for ``ansible.cfg`` in the following locations in this order:
    * ~/.ansible.cfg (in the home directory)
    * /etc/ansible/ansible.cfg
 
-Instructions on how to configure the server list in ``ansible.cfg`` can be found at `configuring the ansible-galaxy client`_. Available options in the Ansible configuration file can be found at `Ansible Configuration Settings`_.
+Instructions on how to configure the server list in ``ansible.cfg`` can be found in `Configuring the ansible-galaxy client`_. Available options in the Ansible configuration file can be found in `Ansible Configuration Settings`_.
 
 .. note:: When hosting a private Galaxy server, available content is not always consistent with what is available on the community Galaxy server.
 

docs/source/modules.rst

@@ -17,7 +17,7 @@ requirements of the managed node. For more detail see :doc:`requirements_managed
 .. _CMCI REST API:
    https://www.ibm.com/docs/en/cics-ts/latest?topic=cmci-how-it-works-rest-api
 
-The region provisioning modules make use of two defaults groups that allow a 
+The region provisioning modules use two defaults groups that allow a 
 user to specify the location of a CICS installation and a high level qualifier 
 for all region data sets to be created under. The example below shows how to 
 use these default groups within the *cics_global_catalog* module.
@@ -34,17 +34,17 @@ use these default groups within the *cics_global_catalog* module.
         state: "initial"
 
 
-In the above example the global catalog will be created at the data set location 
-*REGIONS.ABCD0001.DFHGCD* and the CICS load libraries can be found at the 
-location *CICSTS61.CICS*, meaning the library SDFHLOAD could be found at 
+In the above example, the global catalog will be created at the data set location 
+*REGIONS.ABCD0001.DFHGCD*, and the CICS load libraries can be found at the 
+location *CICSTS61.CICS*, which means that the SDFHLOAD library could be found at 
 *CICSTS61.CICS.SDFHLOAD*.
 
-These groups can be placed in a `module_defaults`_ section meaning all 
+These groups can be placed in a `module_defaults`_ section, which means that all 
 the CICS provisioning modules will use the same high level qualifier for the 
-regions data sets, and the location of the CICS installation only has to be 
+region data sets, and the location of the CICS installation only has to be 
 declared once for all the modules.
 
-To override a specific task's data set location and/or name you can provide an
+To override the data set location or name for a specific task, you can provide an 
 additional parameter to the ``region_data_sets`` group as shown in the example 
 for a global catalog data set below.
 

docs/source/modules/auxiliary_temp.rst

@@ -14,9 +14,9 @@ Synopsis
 
 Create and remove the \ `auxiliary temporary storage <https://www.ibm.com/docs/en/cics-ts/latest?topic=sets-defining-auxiliary-temporary-storage-data-set>`__\  data set used by a CICS® region.
 
-Useful when provisioning or de-provisioning a CICS region.
+You can use this module when provisioning or de-provisioning a CICS region.
 
-Use the \ :literal:`state`\  option to specify the intended state for the auxiliary temp data set. For example, \ :literal:`state=initial`\  will create a auxiliary temp data set if it doesn't yet exist.
+Use the \ :literal:`state`\  option to specify the intended state for the auxiliary temporary storage data set. For example, \ :literal:`state=initial`\  will create an auxiliary temporary storage data set if it doesn't exist.
 
 
 
@@ -27,56 +27,56 @@ Parameters
 ----------
 
   space_primary (False, int, 200)
-    The size of the auxiliary temporary storage data set's primary space allocation. Note, this is just the value; the unit is specified with \ :literal:`space\_type`\ .
+    The size of the primary space allocated to the auxiliary temporary storage data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ .
 
-    This option only takes effect when the auxiliary temporary storage is being created. If it already exists, it has no effect.
+    This option takes effect only when the auxiliary temporary storage data set is being created. If the data set already exists, the option has no effect.
 
-    The auxiliary temporary storage data set's secondary space allocation is set to 10.
+    The size value of the secondary space allocation for the auxiliary temporary storage data set is 10; the unit is specified with \ :literal:`space\_type`\ .
 
 
   space_type (False, str, REC)
-    The unit portion of the auxiliary temporary storage data set size. Note, this is just the unit; the value is specified with \ :literal:`space\_primary`\ .
+    The unit portion of the auxiliary temporary storage data set size. Note that this is just the unit; the value is specified with \ :literal:`space\_primary`\ .
 
-    This option only takes effect when the auxiliary temporary storage is being created. If it already exists, it has no effect.
+    This option takes effect only when the auxiliary temporary storage data set is being created. If the data set already exists, the option has no effect.
 
     The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), records (\ :literal:`REC`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
 
 
   region_data_sets (True, dict, None)
-    The location of the region's data sets using a template, e.g. \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ .
+    The location of the region data sets to be created using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ .
+
+    If you want to use a data set that already exists, ensure that the data set is an auxiliary temporary storage data set.
 
 
     template (False, str, None)
-      The base location of the region's data sets with a template.
+      The base location of the region data sets with a template.
 
 
     dfhtemp (False, dict, None)
       Overrides the templated location for the auxiliary temporary storage data set.
 
 
       dsn (False, str, None)
-        Data set name of the auxiliary temporary storage to override the template.
+        The data set name of the auxiliary temporary storage to override the template.
 
 
 
 
   cics_data_sets (False, dict, None)
-    The name of the \ :literal:`SDFHLOAD`\  data set, e.g. \ :literal:`CICSTS61.CICS.SDFHLOAD`\ .
+    The name of the \ :literal:`SDFHLOAD`\  library of the CICS installation, for example, \ :literal:`CICSTS61.CICS.SDFHLOAD`\ .
 
 
     template (False, str, None)
-      Templated location of the cics install data sets.
+      The templated location of the \ :literal:`SDFHLOAD`\  library.
 
 
     sdfhload (False, str, None)
-      Location of the sdfhload data set.
-
-      Overrides the templated location for sdfhload.
+      The location of the \ :literal:`SDFHLOAD`\  library to override the template.
 
 
 
   state (True, str, None)
-    The desired state for the auxiliary temporary storage, which the module will aim to achieve.
+    The intended state for the auxiliary temporary storage data set, which the module will aim to achieve.
 
     \ :literal:`absent`\  will remove the auxiliary temporary storage data set entirely, if it already exists.
 
@@ -132,7 +132,7 @@ failed (always, bool, )
 
 
 start_state (always, dict, )
-  The state of the auxiliary temporary storage before the task runs.
+  The state of the auxiliary temporary storage before the Ansible task runs.
 
 
   vsam (always, bool, )
@@ -145,7 +145,7 @@ start_state (always, dict, )
 
 
 end_state (always, dict, )
-  The state of the auxiliary temporary storage at the end of the task.
+  The state of the auxiliary temporary storage at the end of the Ansible task.
 
 
   vsam (always, bool, )
@@ -158,7 +158,7 @@ end_state (always, dict, )
 
 
 executions (always, list, )
-  A list of program executions performed during the task.
+  A list of program executions performed during the Ansible task.
 
 
   name (always, str, )

docs/source/modules/csd.rst

@@ -12,11 +12,11 @@ csd -- Create, remove, and manage the CICS CSD
 Synopsis
 --------
 
-Create, remove, and manage the \ `csd <https://www.ibm.com/docs/en/cics-ts/6.1?topic=configuring-setting-up-shared-data-sets-csd-sysin>`__\  data set used by a CICS® region.
+Create, remove, and manage the \ `CICS system definition data set <https://www.ibm.com/docs/en/cics-ts/6.1?topic=configuring-setting-up-shared-data-sets-csd-sysin>`__\  (CSD) used by a CICS® region.
 
-Useful when provisioning or de-provisioning a CICS region, or when managing the state of the CSD during upgrades or restarts.
+You can use this module when provisioning or de-provisioning a CICS region, or when managing the state of the CSD during upgrades or restarts.
 
-Use the \ :literal:`state`\  option to specify the intended state for the CSD. For example, \ :literal:`state=initial`\  will create and initialize a CSD data set if it doesn't yet exist, or it will take an existing CSD and empty it of all records.
+Use the \ :literal:`state`\  option to specify the intended state for the CSD. For example, \ :literal:`state=initial`\  will create and initialize a CSD if it doesn't exist, or it will take an existing CSD and empty it of all records.
 
 
 
@@ -27,60 +27,58 @@ Parameters
 ----------
 
   space_primary (False, int, 4)
-    The size of the CSD data set's primary space allocation. Note, this is just the value; the unit is specified with \ :literal:`space\_type`\ .
+    The size of the primary space allocated to the CSD. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ .
 
-    This option only takes effect when the CSD is being created. If it already exists, it has no effect.
+    This option takes effect only when the CSD is being created. If the CSD already exists, the option has no effect.
 
-    The CSD data set's secondary space allocation is set to 1.
+    The size value of the secondary space allocation for the CSD is 1; the unit is specified with \ :literal:`space\_type`\ .
 
 
   space_type (False, str, M)
-    The unit portion of the CSD data set size. Note, this is just the unit; the value is specified with \ :literal:`space\_primary`\ .
+    The unit portion of the CSD size. Note that this is just the unit; the value is specified with \ :literal:`space\_primary`\ .
 
-    This option only takes effect when the CSD is being created. If it already exists, it has no effect.
+    This option takes effect only when the CSD is being created. If the CSD already exists, the option has no effect.
 
     The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), records (\ :literal:`REC`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
 
 
   region_data_sets (True, dict, None)
-    The location of the region's data sets using a template, e.g. \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ .
+    The location of the region data sets to be created using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ .
 
 
     template (False, str, None)
-      The base location of the region's data sets with a template.
+      The base location of the region data sets with a template.
 
 
     dfhcsd (False, dict, None)
-      Overrides the templated location for the CSD data set.
+      Overrides the templated location for the CSD.
 
 
       dsn (False, str, None)
-        Data set name of the CSD to override the template.
+        The data set name of the CSD to override the template.
 
 
 
 
   cics_data_sets (True, dict, None)
-    The name of the \ :literal:`SDFHLOAD`\  data set, e.g. \ :literal:`CICSTS61.CICS.SDFHLOAD`\ .
+    The name of the \ :literal:`SDFHLOAD`\  library of the CICS installation, for example, \ :literal:`CICSTS61.CICS.SDFHLOAD`\ .
 
 
     template (False, str, None)
-      Templated location of the cics install data sets.
+      The templated location of the \ :literal:`SDFHLOAD`\  library.
 
 
     sdfhload (False, str, None)
-      Location of the sdfhload data set.
-
-      Overrides the templated location for sdfhload.
+      The location of the \ :literal:`SDFHLOAD`\  library to override the template.
 
 
 
   state (True, str, None)
-    The desired state for the CSD, which the module will aim to achieve.
+    The intended state for the CSD, which the module will aim to achieve.
 
-    \ :literal:`absent`\  will remove the CSD data set entirely, if it already exists.
+    \ :literal:`absent`\  will remove the CSD entirely, if it already exists.
 
-    \ :literal:`initial`\  will create the CSD data set if it does not already exist, and initialise it using dfhcsdup
+    \ :literal:`initial`\  will create the CSD if it does not already exist, and initialize it by using DFHCSDUP.
 
     \ :literal:`warm`\  will retain an existing CSD in its current state.
 
@@ -146,33 +144,33 @@ failed (always, bool, )
 
 
 start_state (always, dict, )
-  The state of the CSD before the task runs.
+  The state of the CSD before the Ansible task runs.
 
 
   vsam (always, bool, )
     True if the data set is a VSAM data set.
 
 
   exists (always, bool, )
-    True if the CSD data set exists.
+    True if the CSD exists.
 
 
 
 end_state (always, dict, )
-  The state of the CSD at the end of the task.
+  The state of the CSD at the end of the Ansible task.
 
 
   vsam (always, bool, )
     True if the data set is a VSAM data set.
 
 
   exists (always, bool, )
-    True if the CSD data set exists.
+    True if the CSD exists.
 
 
 
 executions (always, list, )
-  A list of program executions performed during the task.
+  A list of program executions performed during the Ansible task.
 
 
   name (always, str, )