Update links to RHEL docs #3429

rh-max · 2024-11-05T15:14:27Z

What changes are you introducing?

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

Fixing broken links to RHEL docs found by linkchecker.

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

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.12/Katello 4.14 (Satellite 6.16)
Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only)
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)
Foreman 3.6/Katello 4.8
Foreman 3.5/Katello 4.7 (Satellite 6.13; orcharhino 6.6/6.7)
We do not accept PRs for Foreman older than 3.5.

github-actions · 2024-11-05T15:17:16Z

The PR preview for 8f4294a is available at theforeman-foreman-documentation-preview-pr-3429.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

rh-max · 2024-11-05T15:50:10Z

@maximiliankolb Hi Max, could you PTAL at the Salt repo updated links? I'm not sure every accompanying text is fitting the new link. Thanks.
6419357

Lennonka

Thank you, Maxi. RHEL links seem to be correct.

I recommend just a couple of minor tweaks.

guides/common/modules/ref_storage-requirements.adoc

guides/common/modules/con_kickstart-workflow.adoc

guides/common/attributes-base.adoc

Co-authored-by: Lena Ansorgová <[email protected]>

rh-max · 2024-11-06T08:27:28Z

Thanks for reviews Lena & Aneta.
I've set the cherrypicks for all supported versions, please let me know if that's incorrect.

asteflova · 2024-11-06T09:21:43Z

Thanks for reviews Lena & Aneta. I've set the cherrypicks for all supported versions, please let me know if that's incorrect.

Yes, it's a good idea to try to fix the links in all branches, thanks for that. From peeking at the changes you're making, I also expect conflicts on some of those branches. Not a problem now, of course, I'm just sharing that to manage expectations :)

@rh-max Have you noticed the deploy / build-html check failure? Let me know if you'd like help with troubleshooting.

asteflova · 2024-11-06T09:27:00Z

Meanwhile, I've done a bit of a label maintenance, setting tech review done (because this kind of link change doesn't IMO need tech review) and style review needed (because there is no peer review ack yet). This is a fairly recent addition to contributing guidelines and the exact workflow definition is still work in progress in case you'd like to contribute with your feedback @rh-max

rh-max · 2024-11-06T12:48:18Z

guides/common/modules/ref_kinds-of-provisioning-templates.adoc

-* {RHELDocsBaseURL}9/html-single/performing_an_advanced_rhel_9_installation/index#kickstart_references[Kickstart references] in _Performing an advanced RHEL 9 installation_
-* {RHELDocsBaseURL}8/html-single/performing_an_advanced_rhel_8_installation/index#kickstart_references[Kickstart references] in _Performing an advanced RHEL 8 installation_
+* {RHELDocsBaseURL}9/html/automatically_installing_rhel/automated-installation-workflow_rhel-installer[Automated installation workflow] in _Automatically installing RHEL{nbsp}9_
+* {RHELDocsBaseURL}8/html/automatically_installing_rhel/automated-installation-workflow_rhel-installer[Automated installation workflow] in _Automatically installing RHEL{nbsp}8_
 * {RHELDocsBaseURL}7/html/installation_guide/sect-kickstart-syntax[Kickstart Syntax Reference] in the _{RHEL}{nbsp}7 Installation Guide_


Ignoring the Vale output since the offending string is part of the link.

asteflova · 2024-11-06T14:22:49Z

#3411 addressed the linkchecker errors related to Salt. I'm leaving the re-review to @Lennonka.

Lennonka

LGTM

Lennonka · 2024-11-06T14:49:36Z

Cherry picked:

1cfeafe..f00d50a 3.13 -> 3.13 (update)
2d5b1b9..316a5b2 3.12 -> 3.12
b252fcc..433e356 3.11 -> 3.11

@rh-max There are conflicts on 3.10. Please, file another PR for older branches.

asteflova · 2024-11-07T06:32:24Z

@Lennonka It looks like this didn't get cherry-picked into 3.13. Can you please look into it?

(cherry picked from commit 433e356)

Lennonka · 2024-11-07T15:49:14Z

@asteflova Thank you for the reminder! CP'd to 3.13 and comment above updated.

(cherry picked from commit 433e356)

Update links to RHEL docs

2a9d296

pr-processor bot added the Not yet reviewed label Nov 5, 2024

Lennonka requested changes Nov 5, 2024

View reviewed changes

guides/common/modules/ref_storage-requirements.adoc Outdated Show resolved Hide resolved

guides/common/modules/con_kickstart-workflow.adoc Outdated Show resolved Hide resolved

pr-processor bot added Waiting on contributor Requires an action from the author and removed Not yet reviewed labels Nov 5, 2024

asteflova reviewed Nov 5, 2024

View reviewed changes

guides/common/attributes-base.adoc Outdated Show resolved Hide resolved

pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Nov 6, 2024

rh-max and others added 2 commits November 6, 2024 09:19

Apply suggestions from code review

64d789c

Co-authored-by: Lena Ansorgová <[email protected]>

Improve link descriptions

d274fa9

rh-max force-pushed the update-links-to-rhel branch from e6f7b01 to d274fa9 Compare November 6, 2024 08:22

asteflova added tech review done No issues from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Nov 6, 2024

Fix attribute

8f4294a

rh-max commented Nov 6, 2024

View reviewed changes

pr-processor bot removed the Needs re-review label Nov 6, 2024

apinnick mentioned this pull request Nov 6, 2024

Formatting: One sentence per line #3423

Merged

3 tasks

rh-max added the Needs re-review label Nov 6, 2024

Lennonka approved these changes Nov 6, 2024

View reviewed changes

pr-processor bot removed the Needs re-review label Nov 6, 2024

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 Nov 6, 2024

Lennonka merged commit 94a772a into theforeman:master Nov 6, 2024
7 of 9 checks passed

Lennonka pushed a commit that referenced this pull request Nov 6, 2024

Update links to RHEL docs (#3429)

316a5b2

Lennonka pushed a commit that referenced this pull request Nov 6, 2024

Update links to RHEL docs (#3429)

433e356

rh-max pushed a commit to rh-max/foreman-documentation that referenced this pull request Nov 7, 2024

Update links to RHEL docs (theforeman#3429)

85ce2cd

rh-max mentioned this pull request Nov 7, 2024

Update links to RHEL docs (#3429) #3435

Merged

rh-max added a commit to rh-max/foreman-documentation that referenced this pull request Nov 7, 2024

Update links to RHEL docs (theforeman#3429)

4dc79d8

(cherry picked from commit 433e356)

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

f00d50a

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

8fc6c7a

(cherry picked from commit 433e356)

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

80c9a58

(cherry picked from commit 433e356)

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

69408ef

(cherry picked from commit 433e356)

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

0adf6f3

(cherry picked from commit 433e356)

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

4ac80fe

(cherry picked from commit 433e356)

Lennonka pushed a commit that referenced this pull request Nov 7, 2024

Update links to RHEL docs (#3429)

50213b2

(cherry picked from commit 433e356)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update links to RHEL docs #3429

Update links to RHEL docs #3429

rh-max commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

rh-max commented Nov 5, 2024

Lennonka left a comment

rh-max commented Nov 6, 2024

asteflova commented Nov 6, 2024

asteflova commented Nov 6, 2024

rh-max Nov 6, 2024 •

edited

Loading

asteflova commented Nov 6, 2024

Lennonka left a comment

Lennonka commented Nov 6, 2024 •

edited

Loading

asteflova commented Nov 7, 2024

Lennonka commented Nov 7, 2024

Update links to RHEL docs #3429

Update links to RHEL docs #3429

Conversation

rh-max commented Nov 5, 2024 • edited Loading

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.)

Checklists

github-actions bot commented Nov 5, 2024 • edited Loading

rh-max commented Nov 5, 2024

Lennonka left a comment

Choose a reason for hiding this comment

rh-max commented Nov 6, 2024

asteflova commented Nov 6, 2024

asteflova commented Nov 6, 2024

rh-max Nov 6, 2024 • edited Loading

Choose a reason for hiding this comment

asteflova commented Nov 6, 2024

Lennonka left a comment

Choose a reason for hiding this comment

Lennonka commented Nov 6, 2024 • edited Loading

asteflova commented Nov 7, 2024

Lennonka commented Nov 7, 2024

rh-max commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

rh-max Nov 6, 2024 •

edited

Loading

Lennonka commented Nov 6, 2024 •

edited

Loading