ansible-collections / ibm_zos_core

Red Hat Ansible Certified Content for IBM Z
75 stars 44 forks source link

[community] [docs] Draft New "Ansible with z/OS" section #1404

Open ketankelkar opened 3 months ago

ketankelkar commented 3 months ago

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 over zos_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

This includes the actual wording/phrasing, the formatting, examples, etc.

ketankelkar commented 3 months ago

here's how to build the docsite locally- https://docs.ansible.com/ansible/latest/community/documentation_contributions.html