ansible-examples icon indicating copy to clipboard operation
ansible-examples copied to clipboard

Input parameters for the example playbooks are undocumented

Open andy-maier opened this issue 2 years ago • 1 comments

I looked at some example playbooks and they all seem to be using variables deep inside some role, but there is no documentation about that.

Are there any best practices on how to document:

  • the input and output parameters of roles?
  • the input parameters of playbooks?

andy-maier avatar Jul 01 '22 15:07 andy-maier

Try one of these:

  • https://redhat-cop.github.io/automation-good-practices/#_roles_good_practices_for_ansible
  • https://docs.ansible.com/ansible/latest/tips_tricks/index.html
  • https://ansible.readthedocs.io/projects/lint/rules/

RayJin2000 avatar Mar 18 '24 13:03 RayJin2000