📖 Documenting Ansible

This page centralizes all documentation workflows and contributor guides for Ansible. It provides a single reference point for understanding how playbooks, roles, and inventories are documented, and how to contribute new items consistently.

🗂 Documentation Workflows

Automated GitHub Actions generate Markdown documentation and maintain global indexes for all Ansible artifacts. Each action runs a dedicated script that performs the documentation generation.

• Playbooks – generated via the Generate Ansible Playbook Docs GitHub Action, which runs the Generate Playbook Documentation Script
• Roles – generated via the Generate Ansible Role Docs GitHub Action, which runs the Generate Role Documentation Script
• Inventories – generated via the Generate Ansible Inventory Docs GitHub Action, which runs the Generate Inventory Documentation Script

These scripts enforce metadata, comments, and structured READMEs so that all artifacts are easy to understand and maintain.

🏗 Contributor Guides

Guides for adding new items to the Ansible environment:

• Adding a New Playbook: Contributor Guide Adding a New Ansible Playbook
• Adding a New Role: Contributor Guide Adding a New Ansible Role
• Adding a New Inventory: Contributor Guide Adding a New Ansible Inventory

Following these guides ensures that your contributions automatically integrate with the GitHub Actions and scripts to generate documentation and update global indexes.

🔗 Quick Reference

For related resources and context:

• Directory Structure & Conventions
• Quick-Start Checklist