Extending content for users reading 'defaults/main.yml' file

ansible-lockdown / RHEL9-CIS

Ansible role for Red Hat 9 CIS Baseline

https://ansible-lockdown.readthedocs.io

MIT License

119 stars 91 forks source link

Extending content for users reading 'defaults/main.yml' file #157

Closed ipruteanu-sie closed 9 months ago

ipruteanu-sie commented 9 months ago

Overall Review of Changes: Extended the documentation @ defaults/main.yml file, with help of @brisky, as one can notice below. @uk-bolly: If you notice anything strange/unclear in this PR, please let me know.

Issue Fixes: N/A

Enhancements: Enhanced docs.

How has this been tested?: N/A, just docs.

uk-bolly commented 9 months ago

hi @ipruteanu-sie

Thank you and @brisky so much for the PR, Happy to take it as it stands and it is lovely to have and see how we get on with the next CIS baseline release. If you can resolve the issues with the pipeline and DCO failures. For a note: While we do like the changes and documentation, we are seeing more and more complete movements of controls to different numbering and sections e.g. RHEL8-CIS v3 is nearly a complete rewrite due to changes. This has the potential to add to the overhead to document for each release.

Many thanks as always for your help

uk-bolly

ipruteanu-sie commented 9 months ago

Hi @uk-bolly ! Thanks for your suggestions!

Actually, I've been running around in circles trying to fix the DCO issue: I was performing the rebase with the "--signoff", but actually the DCO output was still suggesting(correctly) that the changes related to rebase were unsigned. I've ended up with creating a patch, apply it(with signoff, ofc) on a new branch and generate a new PR, therefore current PR can be closed, as it was replaced by the new one.
Also, we understand the overhead needed for maintaining docs from release to release, but we also believe that the role-usability is improved when users have the chance to read a complete explanation about the variables they're dealing with.