CY22Q4 Health Assessment - Module Documentation Improvement

User Stories

Based on Health assessment result of Q4 and issues being filed by customer/ community we as team decided to prioritise the module improvement documentation work.

Definition of Done

Agreed upon: 

• Every associate takes one module and reviews documentation for all platforms (The idea is to make sure that the documentation is consistent across all platforms).

• Update module parameter in documentation if missing  
• Check the existing DOC and vendor specific online documentation and update DOC with right examples
• Coordinate in the #networking-field channel when the DRAFT PR is up to get field's feedback.
• ansible-lint to lint examples/docstring in plugins.

Documentation example layout:

# Using {{ action_state }}


# Before state:
# -------------
# {{ running-config command output before play execution }}


{{ THE PLAYBOOK UNCOMMENTED }}


# Task Output
# -------------
# before:
# {{ before facts from the playbook execution }}
# commands:
#{{ commands generated by the play }}
# after:
# {{ after facts from the playbook execution }}


# After state:
# ------------
# {{ running-config command output after play execution }}

 


# Using {{ gathered | rendered }}


# Before state:
# ------------
# {{ running-config command output before play execution }}


{{ THE PLAYBOOK UNCOMMENTED }}
 
# Task Output
# -----------
# {{ gathered | rendered state output }}



# Using parsed


# parsed.cfg
# ------------
# {{ raw configuration }}


{{ THE PLAYBOOK UNCOMMENTED }}


# Task Output
# -----------
# {{ parsed state output }}

Note - Verbose output as yaml increases readability and makes the examples much cleaner, using stdout_callback = yaml in ansible.cfg is recommended for copying out verbose output. ref PR : ExamplePR

Collections Affected

1. ARISTA.EOS
2. CISCO.IOS
3. CISCO.IOSXR
4. CISCO.NXOS
5. JUNIPERNETWORKS.JUNOS
6. VYOS.VYOS