Skip to content

Fix style issues related to Managing Security Compliance (Monitoring compliance) - #5147

Draft
jberendz wants to merge 1 commit into
theforeman:masterfrom
jberendz:clean-up-managing-security-compliance_monitoring
Draft

Fix style issues related to Managing Security Compliance (Monitoring compliance)#5147
jberendz wants to merge 1 commit into
theforeman:masterfrom
jberendz:clean-up-managing-security-compliance_monitoring

Conversation

@jberendz

@jberendz jberendz commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

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

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.19/Katello 4.21
  • Foreman 3.18/Katello 4.20 (Satellite 6.19; orcharhino 7.9)
  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6, 7.7, and 7.8)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • We do not accept PRs for Foreman older than 3.14.

@github-actions github-actions Bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Aug 4, 2026
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

@maximiliankolb

Copy link
Copy Markdown
Contributor

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.

@jberendz
jberendz marked this pull request as ready for review August 6, 2026 20:59
@jberendz jberendz closed this Aug 6, 2026
@jberendz jberendz reopened this Aug 6, 2026
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
@jberendz
jberendz force-pushed the clean-up-managing-security-compliance_monitoring branch from cc84967 to 652d191 Compare August 6, 2026 23:13
@jberendz

jberendz commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

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.

@jberendz
jberendz marked this pull request as draft August 7, 2026 03:40
@maximiliankolb

Copy link
Copy Markdown
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing Not yet reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants