Bug 1962976

Summary: Internal links in README.md are broken
Product: Red Hat Enterprise Linux 8 Reporter: Noriko Hosoi <nhosoi>
Component: rhel-system-rolesAssignee: Noriko Hosoi <nhosoi>
Status: CLOSED ERRATA QA Contact: David Jež <djez>
Severity: unspecified Docs Contact: Eliane Ramos Pereira <elpereir>
Priority: unspecified    
Version: 8.5CC: djez, elpereir, nhosoi, rmeggins, spetrosi
Target Milestone: betaKeywords: Triaged
Target Release: 8.5Flags: pm-rhel: mirror+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: rhel-system-roles-1.2.2-3.el8 Doc Type: Bug Fix
Doc Text:
.RHEL System Roles internal links in `README.md` are no longer broken Previously, the internal links available in the `README.md` files were broken. Consequently, if a user clicked a specific section documentation link, it would not redirect users to the specific `README.md` section. This update fixes the issue and now the internal links point users to the correct section.
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-11-09 17:45:29 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Noriko Hosoi 2021-05-20 23:48:34 UTC
Description of problem:
Failure example:
  Clicking the link "Port and SELinux" does not jump to the section.
  ==> README.md <==
  See also [Port and SELinux](#port-and-selinux).
    << snip>>
  ### Port and SELinux

These README files contain internal links.
  certificate/README.md
  cockpit/README.md
  ha_cluster/README.md
  logging/README.md
  network/README.md
  storage/README.md
  vpn/README.md

Comment 3 Rich Megginson 2021-06-09 16:46:44 UTC
@nhosoi this only affects the rendering in Automation Hub, correct?

Comment 4 Noriko Hosoi 2021-06-09 17:30:39 UTC
(In reply to Rich Megginson from comment #3)
> @nhosoi this only affects the rendering in Automation Hub,
> correct?

Not really, it affects the html files in /usr/share/doc/{linux,rhel}-system-roles/collection/roles/ROLENAME/, as well.

Note: it does _not_ affect the html files in /usr/share/doc/{linux,rhel}-system-roles/ROLENAME/.

Comment 16 errata-xmlrpc 2021-11-09 17:45:29 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (rhel-system-roles bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2021:4159