Skip to content

Fix asciidoctor-dita-vale errors for the ConceptLink rule (3.16)#4812

Open
aneta-petrova wants to merge 3 commits intotheforeman:3.16from
aneta-petrova:ConceptLink-3-16
Open

Fix asciidoctor-dita-vale errors for the ConceptLink rule (3.16)#4812
aneta-petrova wants to merge 3 commits intotheforeman:3.16from
aneta-petrova:ConceptLink-3-16

Conversation

@aneta-petrova
Copy link
Copy Markdown
Member

What changes are you introducing?

Applying #4801 (or rather its cherry-pick on 3.17) to 3.16

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

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.18/Katello 4.20 (Satellite 6.19)
  • 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)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

@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 May 5, 2026
@aneta-petrova aneta-petrova removed 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 May 5, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

The PR preview for a319c98 is available at theforeman-foreman-documentation-preview-pr-4812.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova aneta-petrova marked this pull request as ready for review May 5, 2026 14:46
@aneta-petrova
Copy link
Copy Markdown
Member Author

#4801 updated the content type of the "guide not ready" module from concept to reference, and the include paths referencing that file had to be updated on 3.16 to resolve the build failures I mentioned in #4801 (comment).

This PR contains the same changes as #4801 as cherry-picked on 3.17, with the addition of updating the "guide not ready" module includes and removing two unused modules. Therefore, I don't think the full review process is needed and I'll merge tomorrow towards the end of the day (unless there are objections of course :))

Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reproduced locally: There is one merge conflict when cherry-picking the first commit which I had a look at. Second and third commit LGTM.

IMO this is OK to get merged.

You can back up your {Project} deployment to ensure the continuity of your {ProjectName} deployment and associated data in case a disaster occurs.
If your deployment uses custom configurations, you must consider how to handle these custom configurations when you plan your backup and disaster recovery policy.

include::snip_backup-usecase-note.adoc[]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, this snippet is present on 3.16; indicated by the fact that your third commit deletes it. IMO either way is OK.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants