Recommended practices for all elements of automation using Ansible, starting with collections and roles, continuing with playbooks, inventories and plug-ins... These good practices are planned to be used by all Red Hat teams interested but can of course be used by others.
The idea would be to generate docs/index.html (and CONTRIBUTE.html) later on automatically through a pipeline. The same pipeline could create also the PDF
The 2nd commit changes the recommendations' title into sections. This makes the table of content much more meaningful and renders also better in PDF:
Compared to the previous rendering:
I kept two separate commits so that you can compare the outputs of the HTML.
There are two commits in this PR:
The first one adds a
docs/index.htmlfile.The idea would be to generate
docs/index.html(and CONTRIBUTE.html) later on automatically through a pipeline. The same pipeline could create also the PDFFor now manual creation will do, so that https://redhat-cop.github.io/automation-good-practices/ offers a rendered version of the good practices.
The 2nd commit changes the recommendations' title into sections. This makes the table of content much more meaningful and renders also better in PDF:
Compared to the previous rendering:
I kept two separate commits so that you can compare the outputs of the HTML.