ibm_zos_core
ibm_zos_core copied to clipboard
[community] [docs] Draft New "Ansible with z/OS" section
Draft the content for a new section similar to the Using Ansible on Windows and BSD page.
Intention-
In this section we would inform users of the required environment variables needed to allow for community modules to manage z/OS nodes. We would also describe when it might be good to use one of the ibm_zos_core modules over a community one, for example, when to use
copy
overzos_copy
.Improving the documentation would provide a better user experience when leveraging Ansible community modules with z/OS and would be better to have this information in the community docs instead our current Ansible z documentation.
Roughly, we’re thinking, a new sub-section under the “USING ANSIBLE” section, with sub-topics:
‘Using Ansible with z/OS’:
- Configuring a z/OS managed node
- Configuring environment variables for use with z/OS managed nodes
- Configuring python, ssh and other dependencies
Capabilities for z/OS target nodes within the bounds of Ansible builtin.community modules
- Expand on UTF-8 and EBCDIC
- (EBCDIC is a very common and prevalent encoding on z/OS mainframes)
- Explaining when to use the community modules over the ibm_zos_core collection modules.
- Expanding the scope for Ansible with z/OS managed nodes:
- link out to z_ansible_collections_samples GH repo
- https://github.com/IBM/z_ansible_collections_samples
- link out to the unified IBM Z certified collections docs site
- https://ibm.github.io/z_ansible_collections_doc/index.html
This includes the actual wording/phrasing, the formatting, examples, etc.
- Since the repo is public, it should be possible to mock up the new page and achieve a realistic "look-and-feel".
here's how to build the docsite locally- https://docs.ansible.com/ansible/latest/community/documentation_contributions.html