Skip to content

Commit c5c5fa5

Browse files
committed
update URLs to docs: fix links and use shortened URLs when needed
It happened several times that a link we used in reports became invalid over time, so it could not provide expected help to customers. The fix of such links require update of the code, which does not have to be possible on existing releases. Instead of that, we rather decided to use shortnened URLs when possible and when it makes sense to reduce the risk. The benefit is that we are able to change the target destination of such https://red.ht/... URLs so we can fix such issues without the need to update the code (and rpms). New shortened URLs: * https://red.ht/upgrading-rhel7-to-rhel8-main-official-doc * https://red.ht/upgrading-rhel8-to-rhel9-main-official-doc * https://red.ht/ipu-customisation-repos-known-issues * https://red.ht/leapp-dialogs * https://red.ht/file-systems-and-storage-removed-btrfs-rhel-8 * https://red.ht/rhel-8-deploying-different-types-of-servers * https://red.ht/rhel-8-python * https://red.ht/rhel-8-configuring-routing-protocols * https://red.ht/nm-settings-ifcfg-rh * https://red.ht/rhel-9-intel-microarchitectures * https://red.ht/rhel-9-blog-openssh-scp-deprecation Additional changes: * checktargetrepos: replace "TBA" by valid URL for 8 -> 9 docs * dropped unneeded pylint skips
1 parent a81ebb0 commit c5c5fa5

File tree

11 files changed

+12
-20
lines changed

11 files changed

+12
-20
lines changed

repos/system_upgrade/common/actors/checktargetrepos/libraries/checktargetrepos.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,9 @@ def process():
3030
target_major_version = get_target_major_version()
3131

3232
if target_major_version == '8':
33-
ipu_doc_url = (
34-
'https://access.redhat.com/documentation/en-us/'
35-
'red_hat_enterprise_linux/8/html-single/upgrading_from_rhel_7_to_rhel_8/index'
36-
)
33+
ipu_doc_url = ('https://red.ht/upgrading-rhel7-to-rhel8-main-official-doc')
3734
elif target_major_version == '9':
38-
ipu_doc_url = 'TBA'
35+
ipu_doc_url = ('https://red.ht/upgrading-rhel8-to-rhel9-main-official-doc')
3936

4037
rhui_info = next(api.consume(RHUIInfo), None)
4138

repos/system_upgrade/common/actors/localreposinhibit/actor.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ def process(self):
8282
"in-place upgrade"
8383
),
8484
url=(
85-
"https://access.redhat.com/articles/4977891/"
86-
"#repos-known-issues"
85+
"https://red.ht/ipu-customisation-repos-known-issues"
8786
),
8887
),
8988
]

repos/system_upgrade/common/actors/verifydialogs/libraries/verifydialogs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ def check_dialogs(inhibit_if_no_userchoice=True):
88
for dialog in results:
99
sections = dialog.answerfile_sections
1010
summary = ('One or more sections in answerfile are missing user choices: {}\n'
11-
'For more information consult https://leapp.readthedocs.io/en/latest/dialogs.html')
11+
'For more information consult https://red.ht/leapp-dialogs.')
1212
dialog_resources = [reporting.RelatedResource('dialog', s) for s in sections]
1313
dialogs_remediation = ('Please register user choices with leapp answer cli command or by manually editing '
1414
'the answerfile.')

repos/system_upgrade/el7toel8/actors/checkbtrfs/actor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def process(self):
3535
),
3636
reporting.ExternalLink(
3737
title='Considerations in adopting RHEL 8 - btrfs has been removed.',
38-
url='https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/considerations_in_adopting_rhel_8/file-systems-and-storage_considerations-in-adopting-rhel-8#btrfs-has-been-removed_file-systems-and-storage' # noqa: E501; pylint: disable=line-too-long
38+
url='https://red.ht/file-systems-and-storage-removed-btrfs-rhel-8'
3939
),
4040
reporting.ExternalLink(
4141
title='How do I prevent a kernel module from loading automatically?',

repos/system_upgrade/el7toel8/actors/postgresqlcheck/libraries/postgresqlcheck.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
)
1919

2020
# Link URL for postgresql-server report
21-
report_server_inst_link_url = 'https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/deploying_different_types_of_servers/index#migrating-to-a-rhel-8-version-of-postgresql_using-postgresql' # noqa: E501; pylint: disable=line-too-long
21+
report_server_inst_link_url = 'https://red.ht/rhel-8-deploying-different-types-of-servers'
2222

2323
# List of dropped extensions from postgresql-contrib package
2424
report_contrib_inst_dropext = ['dummy_seclabel', 'test_parser', 'tsearch2']

repos/system_upgrade/el7toel8/actors/pythoninformuser/actor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class PythonInformUser(Actor):
1212
tags = (ChecksPhaseTag, IPUWorkflowTag)
1313

1414
def process(self):
15-
url = "https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_basic_system_settings/#using-python3" # noqa: E501; pylint: disable=line-too-long
15+
url = "https://red.ht/rhel-8-python"
1616
title = "Difference in Python versions and support in RHEL 8"
1717
summary = ("In RHEL 8, there is no 'python' command."
1818
" Python 3 (backward incompatible) is the primary Python version"

repos/system_upgrade/el7toel8/actors/quaggareport/actor.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@ def process(self):
3232
create_report([
3333
reporting.Title('Babeld is not available in FRR'),
3434
reporting.ExternalLink(
35-
url='https://access.redhat.com/'
36-
'documentation/en-us/red_hat_enterprise_linux/8/html/'
37-
'configuring_and_managing_networking/setting-your-rou'
38-
'ting-protocols_configuring-and-managing-networking',
35+
url='https://red.ht/rhel-8-configuring-routing-protocols',
3936
title='Setting routing protocols in RHEL8'),
4037
reporting.Summary(
4138
'babeld daemon which was a part of quagga implementation in RHEL7 '

repos/system_upgrade/el8toel9/actors/checkifcfg/libraries/checkifcfg_ifcfg.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ def process():
119119
reporting.RelatedResource('package', 'NetworkManager'),
120120
reporting.ExternalLink(
121121
title='nm-settings-ifcfg-rh - Description of ifcfg-rh settings plugin',
122-
url='https://networkmanager.dev/docs/api/latest/nm-settings-ifcfg-rh.html',
122+
url='https://red.ht/nm-settings-ifcfg-rh',
123123
),
124124
] + [
125125
reporting.RelatedResource('file', fname)

repos/system_upgrade/el8toel9/actors/checkmicroarchitecture/libraries/checkmicroarchitecture.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ def _inhibit_upgrade(missing_flags):
1717
reporting.Title(title),
1818
reporting.Summary(summary),
1919
reporting.ExternalLink(title='Building Red Hat Enterprise Linux 9 for the x86-64-v2 microarchitecture level',
20-
url=('https://developers.redhat.com/blog/2021/01/05/'
21-
'building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level')),
20+
url='https://red.ht/rhel-9-intel-microarchitectures'),
2221
reporting.Severity(reporting.Severity.HIGH),
2322
reporting.Groups([reporting.Groups.INHIBITOR]),
2423
reporting.Groups([reporting.Groups.SANITY]),

repos/system_upgrade/el8toel9/actors/opensshsubsystemsftp/libraries/opensshsubsystemsftp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def process(openssh_messages):
2626
),
2727
reporting.ExternalLink(
2828
title="OpenSSH SCP deprecation in RHEL 9: What you need to know ",
29-
url="https://www.redhat.com/en/blog/openssh-scp-deprecation-rhel-9-what-you-need-know",
29+
url="https://red.ht/rhel-9-blog-openssh-scp-deprecation",
3030
),
3131
]
3232
reporting.create_report([

0 commit comments

Comments
 (0)