Skip to content

Fix content readability issues for upgrading your project section #4171

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Sep 16, 2025
Merged

Fix content readability issues for upgrading your project section #4171

merged 6 commits into from
Sep 16, 2025

Conversation

@AkshayGadhaveRH
Copy link
Contributor

@AkshayGadhaveRH AkshayGadhaveRH commented Aug 19, 2025

Shorten/split long sentences in the 'Upgrading your project' section of the connected upgrade guide.

JIRA: https://issues.redhat.com/browse/SAT-35663

What changes are you introducing?

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.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17)
  • 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.

Review checklists

Tech review (performed by an Engineer who did not author the PR; can be skipped if tech review is unnecessary):

  • The PR documents a recommended, user-friendly path.
  • The PR removes steps that have been made unnecessary or obsolete.
  • Any steps introduced or updated in the PR have been tested to confirm that they lead to the documented end result.

Style review (by a Technical Writer who did not author the PR):

  • The PR conforms with the team's style guidelines.
  • The PR introduces documentation that describes a user story rather than a product feature.

@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 19, 2025
@github-actions
Copy link

github-actions bot commented Aug 19, 2025 •
edited
Loading

The PR preview for be1cb58 is available at theforeman-foreman-documentation-preview-pr-4171.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@Lennonka Lennonka removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Aug 19, 2025
bangelic
bangelic approved these changes Aug 19, 2025
View reviewed changes
Copy link
Contributor

@bangelic bangelic left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

Edit - I prematurely acked. Take a look at my suggestions.

bangelic
bangelic suggested changes Aug 19, 2025
View reviewed changes
@pr-processor pr-processor bot added Waiting on contributor Requires an action from the author Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Aug 19, 2025
evgeni
evgeni reviewed Aug 25, 2025
View reviewed changes
evgeni
evgeni reviewed Aug 25, 2025
View reviewed changes
@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label Aug 25, 2025
@AkshayGadhaveRH AkshayGadhaveRH force-pushed the fix_readability_upgrading_project_section branch from 1c2bc14 to 2997fba Compare September 2, 2025 05:05
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Sep 2, 2025
@maximiliankolb maximiliankolb added the tech review done No issues from the technical perspective label Sep 2, 2025
@Lennonka Lennonka requested a review from bangelic September 4, 2025 01:09
bangelic
bangelic suggested changes Sep 4, 2025
View reviewed changes
@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Sep 4, 2025
@AkshayGadhaveRH AkshayGadhaveRH force-pushed the fix_readability_upgrading_project_section branch from 2997fba to 6cc3aa3 Compare September 9, 2025 10:08
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Sep 9, 2025
@Lennonka Lennonka requested a review from bangelic September 9, 2025 14:09
bangelic
bangelic suggested changes Sep 9, 2025
View reviewed changes
Copy link
Contributor

@bangelic bangelic left a comment

Choose a reason for hiding this comment

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

Other than this small fix, LGTM.

@pr-processor pr-processor bot added Waiting on contributor Requires an action from the author and removed Needs re-review labels Sep 9, 2025
@AkshayGadhaveRH AkshayGadhaveRH force-pushed the fix_readability_upgrading_project_section branch from 6cc3aa3 to be1cb58 Compare September 11, 2025 05:32
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Sep 11, 2025
@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 Needs re-review labels Sep 15, 2025
@Lennonka Lennonka merged commit 5fddab7 into theforeman:master Sep 16, 2025
10 checks passed
Lennonka pushed a commit that referenced this pull request Sep 16, 2025
@AkshayGadhaveRH @Lennonka
Fix content readability issues for upgrading your project section (#4171
d360c0e 
)

* Fix content readability issues for upgrading your project section

Shorten/split long sentences in the 'Upgrading your project' section of the connected upgrade guide.

JIRA: https://issues.redhat.com/browse/SAT-35663
@Lennonka
Copy link
Contributor

Lennonka commented Sep 16, 2025

Cherry picked:

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

Reviewers

@evgeni evgeni evgeni approved these changes

+1 more reviewer

@bangelic bangelic bangelic requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@AkshayGadhaveRH @Lennonka @evgeni @bangelic @maximiliankolb