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 docs folder contains the HTML version of the document.
This folder should never be checked out (hence it should be in the /gitignore file).
Though, we need it to be present while creating the documentation (hence it should be created in the release and in the preview targets in the Makefile).
Also, the github release pipeline should create it (in the docs branch), hence the --force to the git add command in the release pipeline.
mophahr
commented
1 year ago
The
docsfolder contains the HTML version of the document.This folder should never be checked out (hence it should be in the
/gitignorefile). Though, we need it to be present while creating the documentation (hence it should be created in thereleaseand in thepreviewtargets in theMakefile). Also, the github release pipeline should create it (in thedocsbranch), hence the--forceto thegit addcommand in the release pipeline.