Uploaded image for project: 'OCMUI - OpenShift Cluster Manager UI'
  1. OCMUI - OpenShift Cluster Manager UI
  2. OCMUI-3556

Use /latest/ instead of hard-coded version number inside docs links

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • Core UI
    • Future Sustainability
    • 3
    • False
    • Hide

      None

      Show
      None
    • True
    • 3

      We have many docs links across the application, they should be all stored inside: 

      src/common/installLinks.mjs

      Many of them point to the latest version available (4.19 at the time of writing). We achieve this by having a base path that we have to update manually:

      const DOCS_BASE = 'https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html';

      Docs already support links pointing to the latest version using the /latest/ path.

      Replace the docs base with:
      https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html

       

      Acceptance criteria

      • Change all the links inside installLinks.mjs that point to the latest OCP version (4.19) to use the /latest/ path param
      • Verify all changed links are properly working 
      • Verify the run/check-links.mjs  still works properly after the change

      Bonus criteria

      • Not strictly required as part of this ticket but we could also investigate if there's a way to optimize the check-links script to detect also broken internal links. Sometime a link to a doc is still valid but only the anchor link is not working anymore, like http://docs.openshift.com/somepage.html#section-one, but there's no #section-one header anymore because it was renamed

              Unassigned Unassigned
              robertoemanuel Roberto Emanuel
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: