Skip to content
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.

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

update URLs to docs: fix links and use shortened URLs when needed #1086

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

pirat89
Copy link
Member

@pirat89 pirat89 commented Jun 5, 2023

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:

Additional changes:

  • checktargetrepos: replace "TBA" by valid URL for 8 -> 9 docs
  • dropped unneeded pylint skips

Another info

In some cases (at least in targetuserspacecreator - and possibly only in this one case) we have just links to our rhel8 documentation instead of dynamically point people to el8 or el9 docs (if they exists). I am considering to keep this as part of a future changes. In this one PR I do not want to do any changes in behavior.

@pirat89 pirat89 requested a review from fernflower June 5, 2023 16:35
@github-actions
Copy link

github-actions bot commented Jun 5, 2023

Thank you for contributing to the Leapp project!

Please note that every PR needs to comply with the Leapp Guidelines and must pass all tests in order to be mergeable.
If you want to request a review or rebuild a package in copr, you can use following commands as a comment:

  • review please @oamg/developers to notify leapp developers of the review request
  • /packit copr-build to submit a public copr build using packit

Packit will automatically schedule regression tests for this PR's build and latest upstream leapp build. If you need a different version of leapp from PR#42, use /packit test oamg/leapp#42

To launch regression testing public members of oamg organization can leave the following comment:

  • /rerun to schedule basic regression tests using this pr build and latest upstream leapp build as artifacts
  • /rerun 42 to schedule basic regression tests using this pr build and leapp*PR42* as artifacts
  • /rerun-sst to schedule sst tests using this pr build and latest upstream leapp build as artifacts
  • /rerun-sst 42 to schedule sst tests using this pr build and leapp*PR42* as artifacts

Please open ticket in case you experience technical problem with the CI. (RH internal only)

Note: In case there are problems with tests not being triggered automatically on new PR/commit or pending for a long time, please contact leapp-infra.

@pirat89 pirat89 added this to the 8.9/9.3 milestone Jun 5, 2023
@pirat89
Copy link
Member Author

pirat89 commented Jul 28, 2023

@Rezney do you want this one merge before you do the check of problematic URLs and cover them all at once or do you want this one covered prior the merge?

@Rezney
Copy link
Member

Rezney commented Aug 4, 2023

@Rezney do you want this one merge before you do the check of problematic URLs and cover them all at once or do you want this one covered prior the merge?

@pirat89 I am fine with merging this.

@pirat89 pirat89 force-pushed the fix-link branch 3 times, most recently from c5c5fa5 to 0e3cac9 Compare August 22, 2023 10:52
@pirat89 pirat89 requested a review from Rezney August 22, 2023 10:52
@pirat89 pirat89 changed the title checktargetrepos: replace TBA by URL for 8 -> 9 docs update URLs to docs: fix links and use shortened URLs when needed Aug 22, 2023
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-migrate-postgresql-server
  * 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
@Rezney Rezney merged commit d6498b8 into oamg:master Aug 22, 2023
11 of 15 checks passed
@pirat89 pirat89 added the changelog-checked The merger/reviewer checked the changelog draft document and updated it when relevant label Aug 23, 2023
pirat89 added a commit to pirat89/leapp-repository that referenced this pull request Aug 23, 2023
## Packaging
- Requires leapp-framework 5.0

## Upgrade handling
### Fixes
- Add el8toel9 actor to handle directory -> symlink with ruby IRB. (oamg#1076)
- Do not try to update GRUB core on IBM Z systems (oamg#1117)
- Fix failing upgrades with devtmpfs file systems specified in FSTAB (oamg#1090)
- Fix the calculation of the required free space on each partitions/volume for the upgrade transactions (oamg#1097)
- Fix the generation of the report about hybrid images (oamg#1064)
- Handle correctly the installed certificates to allow upgrades with custom repositories using HTTPs with enabled SSL verification (oamg#1106)
- Minor improvements and fixes of various reports (oamg#1066, oamg#1067, oamg#1085)
- Update error messages about leapp data files to inform user how to obtain valid data files (oamg#1121)
- Update links in various reports (oamg#1062, oamg#1086)
- Update the repomap data to cover changed repoids in RHUI Azure (oamg#1087)
- [IPU 7 -> 8] Fix false positive report about invalid symlinks on RHEL 7 (oamg#1052)
- [IPU 8 -> 9] Inhibit the upgrade when unsupported x86-64 microarchitecture is detected (oamg#1059)

### Enhancements
- Include updated leapp data files in the RPM (oamg#1046, oamg#1092, oamg#1119)
- Update the set of supported upgrade paths (oamg#1077):
  - RHEL with SAP HANA 7.9 -> 8.6, 8.8 (default: 8.6)
  - RHEL with SAP HANA 8.8 -> 9.2
- Introduce new upgrade paths:
  - RHEL 7.9 -> 8.9 (default)
  - RHEL 8.9 -> 9.3
- Correctly update grub2 when /boot resides on multiple devices aggregated in RAID (oamg#1093, oamg#1115)
- Enable upgrades for machines using RHUI on AlibabaCloud (oamg#1088)
- Introduce possibility to add kernel drivers to initramfs (oamg#1081)
- Redesign handling of information about kernel (booted and target) in preparation for new changes in RHEL 9 (oamg#1107)
- Redesign source system overlay to use disk images backed by sparse files to optimize disk space consumption (oamg#1097, oamg#1103)
- Requires leapp-framework 5.0 (oamg#1061, oamg#1116)
- Use new leapp CLI API which provides better report summary output (oamg#1061, oamg#1116)
- [IPU 8 -> 9] Detect and report use of deprecated Xorg drivers (oamg#1078)
- [IPU 8 -> 9] Introduce IPU for systems with FIPS enabled (oamg#1053)

## Additional changes interesting for devels
- Deprecated `GrubInfo.orig_device_name` field in the `GrubInfo` model (replaced by `GrubInfo.orig_devices`) (oamg#1093)
- Deprecated `InstalledTargetKernelVersion` model (replaced by `InstalledTargetKernelInfo`) (oamg#1107)
- Deprecated `leapp.libraries.common.config.version.is_rhel_realtime` (check the type in msg `KernelInfo`, field `type`) (oamg#1107)
- Deprecated `leapp.libraries.common.grub.get_grub_device()` (replaced by `leapp.libraries.common.grub.get_grub_devices()`) (oamg#1093)
- Introduced new devel envar LEAPP_DEVEL_KEEP_DISK_IMGS=1 to skip the removal of the created disk images for OVL. That's sometimes handy for the debugging. (oamg#1097)
@pirat89 pirat89 mentioned this pull request Aug 23, 2023
Rezney pushed a commit that referenced this pull request Aug 23, 2023
## Packaging
- Requires leapp-framework 5.0

## Upgrade handling
### Fixes
- Add el8toel9 actor to handle directory -> symlink with ruby IRB. (#1076)
- Do not try to update GRUB core on IBM Z systems (#1117)
- Fix failing upgrades with devtmpfs file systems specified in FSTAB (#1090)
- Fix the calculation of the required free space on each partitions/volume for the upgrade transactions (#1097)
- Fix the generation of the report about hybrid images (#1064)
- Handle correctly the installed certificates to allow upgrades with custom repositories using HTTPs with enabled SSL verification (#1106)
- Minor improvements and fixes of various reports (#1066, #1067, #1085)
- Update error messages about leapp data files to inform user how to obtain valid data files (#1121)
- Update links in various reports (#1062, #1086)
- Update the repomap data to cover changed repoids in RHUI Azure (#1087)
- [IPU 7 -> 8] Fix false positive report about invalid symlinks on RHEL 7 (#1052)
- [IPU 8 -> 9] Inhibit the upgrade when unsupported x86-64 microarchitecture is detected (#1059)

### Enhancements
- Include updated leapp data files in the RPM (#1046, #1092, #1119)
- Update the set of supported upgrade paths (#1077):
  - RHEL with SAP HANA 7.9 -> 8.6, 8.8 (default: 8.6)
  - RHEL with SAP HANA 8.8 -> 9.2
- Introduce new upgrade paths:
  - RHEL 7.9 -> 8.9 (default)
  - RHEL 8.9 -> 9.3
- Correctly update grub2 when /boot resides on multiple devices aggregated in RAID (#1093, #1115)
- Enable upgrades for machines using RHUI on AlibabaCloud (#1088)
- Introduce possibility to add kernel drivers to initramfs (#1081)
- Redesign handling of information about kernel (booted and target) in preparation for new changes in RHEL 9 (#1107)
- Redesign source system overlay to use disk images backed by sparse files to optimize disk space consumption (#1097, #1103)
- Requires leapp-framework 5.0 (#1061, #1116)
- Use new leapp CLI API which provides better report summary output (#1061, #1116)
- [IPU 8 -> 9] Detect and report use of deprecated Xorg drivers (#1078)
- [IPU 8 -> 9] Introduce IPU for systems with FIPS enabled (#1053)

## Additional changes interesting for devels
- Deprecated `GrubInfo.orig_device_name` field in the `GrubInfo` model (replaced by `GrubInfo.orig_devices`) (#1093)
- Deprecated `InstalledTargetKernelVersion` model (replaced by `InstalledTargetKernelInfo`) (#1107)
- Deprecated `leapp.libraries.common.config.version.is_rhel_realtime` (check the type in msg `KernelInfo`, field `type`) (#1107)
- Deprecated `leapp.libraries.common.grub.get_grub_device()` (replaced by `leapp.libraries.common.grub.get_grub_devices()`) (#1093)
- Introduced new devel envar LEAPP_DEVEL_KEEP_DISK_IMGS=1 to skip the removal of the created disk images for OVL. That's sometimes handy for the debugging. (#1097)
@andywaltlova andywaltlova added the report Any reports have been added / removed / changed in the PR label Nov 8, 2023
@pirat89 pirat89 deleted the fix-link branch February 19, 2024 09:13
@pirat89 pirat89 added the shortened-urls PR is introducing new shortened red.ht URLs label Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-checked The merger/reviewer checked the changelog draft document and updated it when relevant report Any reports have been added / removed / changed in the PR shortened-urls PR is introducing new shortened red.ht URLs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants