Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formally turn snippet into module #3661

Merged
merged 2 commits into from
Feb 13, 2025

Conversation

aneta-petrova
Copy link
Member

What changes are you introducing?

Turning the 'guide not ready yet' snippet into a proper module with its own heading.

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

This came up in #3653. Adding the ribbon/banner causes build failures if there are headings missing in certain places. The 'guide not ready yet' snippet is one of them.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

N/A

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.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

@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 Feb 12, 2025
@aneta-petrova aneta-petrova removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Feb 12, 2025
Copy link
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.

We generally use level 1 headings and then use leveloffsets when including modules. However, this is a very special use case: limited to "master.adoc" files, upstream only, and always immediately after the intial heading if at all.

LGTM.

@aneta-petrova
Copy link
Member Author

You are right, Max, let's try to do things properly. The module now has a level 1 heading and a leveloffset is applied for the include directives. Can you please re-review @maximiliankolb?

@aneta-petrova aneta-petrova merged commit b46d0d3 into theforeman:master Feb 13, 2025
9 checks passed
aneta-petrova added a commit to aneta-petrova/foreman-documentation that referenced this pull request Feb 13, 2025
(cherry picked from commit b46d0d3)

Applies the change to one more guide (Administering with Ansible)
@aneta-petrova
Copy link
Member Author

aneta-petrova commented Feb 13, 2025

Merged to "master" but no cherry-picks because 3.13 has one more guide that is also affected by this. To be extra safe, I want to do a separate PR: #3669

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants