Skip to content

Expose containerized Admin guide in navigation - #4983

Merged
aneta-petrova merged 1 commit into
theforeman:masterfrom
aneta-petrova:foremanctl-expose-admin
Jul 1, 2026
Merged

Expose containerized Admin guide in navigation#4983
aneta-petrova merged 1 commit into
theforeman:masterfrom
aneta-petrova:foremanctl-expose-admin

Conversation

@aneta-petrova

@aneta-petrova aneta-petrova commented Jun 26, 2026

Copy link
Copy Markdown
Member

What changes are you introducing?

  • Adding Admin guide to the list of containerized guides in navigation (because it now contains containerized backup documentation that we want users to be aware of)
  • Removing the guide-not-ready snippet (because the snippet was added as an additional warning for users who might stumble across the guide even though it was not in navigation; that's not needed anymore because the guide will be exposed in navigation intentionally and it will contain containerized documentation intended for user consumption)

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

#4850 will add first new content for the Admin guide and after that, we can add it to navigation.

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)
  • 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 labels Jun 26, 2026
@aneta-petrova aneta-petrova removed the Needs tech review Requires a review from the technical perspective label Jun 26, 2026
@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

@aneta-petrova
aneta-petrova marked this pull request as ready for review June 30, 2026 07:16
@aneta-petrova

Copy link
Copy Markdown
Member Author

Now that #4850 has been merged, we can expose the containerized Admin guide in navigation so that users can get access to the backup docs. Can someone please review?

@aneta-petrova
aneta-petrova force-pushed the foremanctl-expose-admin branch from 6c2b67e to 761f2e7 Compare June 30, 2026 07:18
@jafiala
jafiala self-requested a review June 30, 2026 07:41

@jafiala jafiala left a comment

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.

Thank you!

@jafiala jafiala added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Jun 30, 2026
@Lennonka

Copy link
Copy Markdown
Contributor

It might be too early because of a new assembly from #4882
However, we could hide the assembly for containerized for now.

@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label Jun 30, 2026
@aneta-petrova aneta-petrova removed the Waiting on contributor Requires an action from the author label Jun 30, 2026
@aneta-petrova

Copy link
Copy Markdown
Member Author

It might be too early because of a new assembly from #4882 However, we could hide the assembly for containerized for now.

Anything that is not ready for containerization should not be included in ifdef::containerized[] yet. This PR exposes the guide, but the only parts that are included in the containerized preview are certain parts of backup documentation.

@aneta-petrova

Copy link
Copy Markdown
Member Author

I updated the PR's description with a bit more information on the reasoning behind this PR.

@aneta-petrova
aneta-petrova merged commit 643338c into theforeman:master Jul 1, 2026
9 checks passed
@aneta-petrova
aneta-petrova deleted the foremanctl-expose-admin branch July 1, 2026 06:18
jafiala pushed a commit to jafiala/foreman-documentation that referenced this pull request Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

style review done No issues from docs style/grammar perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants