Fix style issues related to Managing Security Compliance (Monitoring compliance) - #5147
Conversation
|
The PR preview for 652d191 is available at theforeman-foreman-documentation-preview-pr-5147.surge.sh The following output files are affected by this PR: |
|
Just a general tip: if you change anchors, please go with all lowercase and dashes instead of underscores. For example: -[id="Compliance_Email_Notifications_{context}"]
+[id="compliance-email-notifications"]The vale check will help you with this too. |
Because this issue is broad and covers multiple sections throughout the entire Managing Security Compliance guide, PRs are broken into chapter reviews per Endeavor's guidance. This PR relates to Section 7, Monitoring compliance
cc84967 to
652d191
Compare
|
Thanks @maximiliankolb . This is my first time working with Vale. Is there an extension you use to have it check your local build? I don't want to rely on finding out after I commit changes. |
To be honest, I don't use Vale locally. With experience, I have a feeling for our conventions. If I notice that Vale complains about my PR, then I usually convert it to a draft and fix issues until Vale is happy or I declare them false positives or out of scope. But maybe @aneta-petrova can help you. It probably depends on your editor. I once had Vale running for markdown files in vim but wasn't happy with it. |
What changes are you introducing?
Remove deprecated
{context}tags in section headings.Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Addressing issues found in Issue #4214
Because this issue is broad and covers multiple sections throughout the entire Managing Security Compliance guide, PRs are broken into chapter reviews per Endeavor's guidance.
This PR relates to Section 7, Monitoring compliance
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Contributor checklists
Please cherry-pick my commits into: