Skip to content

Conversation

maximiliankolb
Copy link
Contributor

What changes are you introducing?

  • Fix chown command based on man page: you split user and group by colon
  • Rename file/anchor/title
  • Use attributes in favor of Katello server

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

Fixes #1191

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

I ran those commands on Foreman 3.14/Katello 4.16, but without seeing any issues before/after. Aka. I did not have a broken test instance which got repaired by these commands. IMO good enough because the PR only moves the module, but does not make any significant changes.

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.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • 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)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • We do not accept PRs for Foreman older than 3.9.

@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 Sep 24, 2025
Copy link

github-actions bot commented Sep 24, 2025

The PR preview for ce68ae8 is available at theforeman-foreman-documentation-preview-pr-4298.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Copy link
Contributor

@Lennonka Lennonka left a comment

Choose a reason for hiding this comment

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

The changes look good to me.

Could we add an xref to the appendix into the Synchronizing repositories module's .Additional resources perhaps?
Since it's an appendix, it might be easy to miss by users.

@pr-processor pr-processor bot added Waiting on contributor Requires an action from the author and removed Not yet reviewed labels Sep 26, 2025
@maximiliankolb maximiliankolb force-pushed the fix_1191_move_troubleshooting_module branch from 891348f to 55c36fd Compare September 26, 2025 12:36
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Sep 26, 2025
@maximiliankolb
Copy link
Contributor Author

Could we add an xref to the appendix into the Synchronizing repositories module's .Additional resources perhaps? Since it's an appendix, it might be easy to miss by users.

Yes we can! -> Rebased to HEAD of "master" and added a link. Please re-review.

@maximiliankolb maximiliankolb removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Sep 26, 2025
* Add link to appropriate modules which could cause the need to
  troubleshoot
* Fix chown command based on man page: you split user and group by colon
* Rename file/anchor/title
* Use attributes in favor of Katello server

Fixes theforeman#1191
@maximiliankolb maximiliankolb force-pushed the fix_1191_move_troubleshooting_module branch from 55c36fd to ce68ae8 Compare September 26, 2025 12:38
@maximiliankolb
Copy link
Contributor Author

Module is Katello-only -> Link is now also Katello-only. I only ran local tests for Katello builds 🙃

Copy link
Contributor

@Lennonka Lennonka left a comment

Choose a reason for hiding this comment

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

LGTM, although the fact that the appendix isn't included for satellite and orcharhino builds is surprising to me :)

@Lennonka Lennonka 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 Sep 29, 2025
@Lennonka Lennonka merged commit 3976c6c into theforeman:master Sep 30, 2025
8 of 10 checks passed
Lennonka pushed a commit that referenced this pull request Sep 30, 2025
* Add link to appropriate modules which could cause the need to
  troubleshoot
* Fix chown command based on man page: you split user and group by colon
* Rename file/anchor/title
* Use attributes in favor of Katello server

Fixes #1191
@Lennonka
Copy link
Contributor

Cherry picked:

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.

Move troubleshooting section to a better place
2 participants