Merge branch 'release-v1.2.0'

Author: ddimatos

README.md

@@ -30,7 +30,7 @@ Ansible Certified Content for IBM Z**, is available on both, **Galaxy**
 as community supported and **Automation Hub** with enterprise support.
 
 For **guides** and **reference**, please visit [the documentation
-site](https://ansible-collections.github.io/ibm_zos_core/).
+site](https://ibm.github.io/z_ansible_collections_doc/index.html).
 
 Features
 ========

docs/ansible_content.rst

@@ -19,6 +19,37 @@ works closely with offerings such as `IBM z/OS IMS collection`_ to deliver
 a solution that will enable you to automate tasks on z/OS subsystems such
 as IMS.
 
+Modules include documentation that is similar to a UNIX, or UNIX-like operating
+system man page (manual page). This documentation can be accessed from the
+command line by using the ``ansible-doc`` command documented in the
+`Ansible guide`_.
+
+Here's how to use the ``ansible-doc`` command after you install the
+**IBM z/OS core collection**: ``ansible-doc ibm.ibm_zos_core.zos_data_set``
+
+.. code-block:: sh
+
+   $ansible-doc ibm.ibm_zos_core.zos_data_set
+
+   > ZOS_DATA_SET    (/Users/user/.ansible/collections/ansible_collections/ibm/ibm_zos_core/plugins/modules/zos_data_set.py)
+
+      Create, delete and set attributes of data sets. When forcing data set replacement, contents will not be preserved.
+
+    OPTIONS (= is mandatory):
+
+    - batch
+            Batch can be used to perform operations on multiple data sets in a single module call.
+            Each item in the list expects the same options as zos_data_set.
+            type: list
+
+    - data_class
+            The data class name (required for SMS-managed data sets)
+            type: str
+
+
+.. _Ansible guide:
+   https://docs.ansible.com/ansible/latest/cli/ansible-doc.html#ansible-doc
+
 .. _IBM z/OS IMS collection:
    https://github.com/ansible-collections/ibm_zos_ims
 

docs/scripts/auto-doc-gen.sh

@@ -16,40 +16,43 @@ DOC_DIR=`( cd "$SCRIPT_PATH" && pwd )| sed 's|\(.*\)/.*|\1|'`
 # Source the playbook*.rst into a single RST so that our topic is a single html
 ################################################################################
 
-# If playbooks-single.rst exists, zero it out so we generate the lastest based
-# on the payboook-*.rst files
-if [[ -f $DOC_DIR/source/playbooks-single.rst  ]]; then
-    :> $DOC_DIR/source/playbooks-single.rst
-fi
-
-# Remove the first toctree entry and onwards from playbooks.rst to create a new
-# RST playbooks-single.rst. Note, you should ensure toctree entries are at the
-# end of the conent to not remove unwanted content.
-if [[ -f $DOC_DIR/source/playbooks.rst ]]; then
-
-    # Remove the toctree entries
-    awk '/toctree/ {exit} {print}' $DOC_DIR/source/playbooks.rst >> $DOC_DIR/source/playbooks-single.rst
-
-    # Concat the interested RSTs into playbooks-single.rst to create a single RST
-    if [[ -f $DOC_DIR/source/playbook_config_setup.rst && -f $DOC_DIR/source/playbook_inventory.rst && -f $DOC_DIR/source/playbook_group_vars.rst && -f $DOC_DIR/source/playbook_run.rst ]]; then
-
-        # Inform readers this is auto generated thus avoding the need to maintain
-        echo ".. ...........................................................................\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
-        echo ".. Auto generated restructured text                                          .\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
-        echo ".. ...........................................................................\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
-
-        # For each identified file we want to merge into playbooks-single.rst cat them and merge
-        for file in $DOC_DIR/source/playbook_config_setup.rst $DOC_DIR/source/playbook_inventory.rst $DOC_DIR/source/playbook_group_vars.rst $DOC_DIR/source/playbook_run.rst; do
-            echo "" >> $DOC_DIR/source/playbooks-single.rst;
-            cat "$file" >> $DOC_DIR/source/playbooks-single.rst;
-        done
-    else
-        # When unable to merge remove the auto generated RST so that is apparent
-        # it is not generated and will diff in a 'git status'
-
-        rm -rf $DOC_DIR/source/playbooks-single.rst
-    fi
-fi
+################################################################################
+# Deprecated playbooks-single.rst
+# # If playbooks-single.rst exists, zero it out so we generate the lastest based
+# # on the payboook-*.rst files
+# if [[ -f $DOC_DIR/source/playbooks-single.rst  ]]; then
+#     :> $DOC_DIR/source/playbooks-single.rst
+# fi
+
+# # Remove the first toctree entry and onwards from playbooks.rst to create a new
+# # RST playbooks-single.rst. Note, you should ensure toctree entries are at the
+# # end of the conent to not remove unwanted content.
+# if [[ -f $DOC_DIR/source/playbooks.rst ]]; then
+
+#     # Remove the toctree entries
+#     awk '/toctree/ {exit} {print}' $DOC_DIR/source/playbooks.rst >> $DOC_DIR/source/playbooks-single.rst
+
+#     # Concat the interested RSTs into playbooks-single.rst to create a single RST
+#     if [[ -f $DOC_DIR/source/playbook_config_setup.rst && -f $DOC_DIR/source/playbook_inventory.rst && -f $DOC_DIR/source/playbook_group_vars.rst && -f $DOC_DIR/source/playbook_run.rst ]]; then
+
+#         # Inform readers this is auto generated thus avoding the need to maintain
+#         echo ".. ...........................................................................\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
+#         echo ".. Auto generated restructured text                                          .\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
+#         echo ".. ...........................................................................\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
+
+#         # For each identified file we want to merge into playbooks-single.rst cat them and merge
+#         for file in $DOC_DIR/source/playbook_config_setup.rst $DOC_DIR/source/playbook_inventory.rst $DOC_DIR/source/playbook_group_vars.rst $DOC_DIR/source/playbook_run.rst; do
+#             echo "" >> $DOC_DIR/source/playbooks-single.rst;
+#             cat "$file" >> $DOC_DIR/source/playbooks-single.rst;
+#         done
+#     else
+#         # When unable to merge remove the auto generated RST so that is apparent
+#         # it is not generated and will diff in a 'git status'
+
+#         rm -rf $DOC_DIR/source/playbooks-single.rst
+#     fi
+# fi
+################################################################################
 
 # If requirements-single.rst exists, zero it out so we generate the lastest based
 # on the requirements-*.rst files

docs/source/conf.py

@@ -47,10 +47,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['playbooks.rst', 'playbook_config_setup.rst',
-                    'playbook_group_vars.rst', 'playbook_inventory.rst',
-                    'playbook_run.rst', 'requirements.rst',
-                    'requirements_managed.rst']
+exclude_patterns = ['requirements.rst', 'requirements_managed.rst']
 
 ##############################################################################
 # Options for HTML output
@@ -150,7 +147,7 @@
 # White list which Git tags documentation will be generated and linked into the
 # version selection box. This is currently a manual selection, until more
 # versions are released, there are no regular expressions used.
-scv_whitelist_tags = ('v1.0.0', 'v1.1.0$', 'v1.2.0-beta.4',)
+scv_whitelist_tags = ('v1.0.0', 'v1.1.0$', 'v1.2.0$',)
 
 # Sort versions by one or more values. Valid values are semver, alpha, and time.
 # Semantic is referred to as 'semver', this would ensure our latest VRM is

docs/source/index.rst

@@ -61,7 +61,7 @@ ansible-doc to automate tasks on z/OS.
 
    installation
    requirements-single
-   playbooks-single
+   playbooks
 
 .. toctree::
    :maxdepth: 1