Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-62708

Links 404ing in OKD docs

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 4.19.z
    • Documentation
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

          We seem to have a ton of broken links in the OKD docs.

      Version-Release number of selected component (if applicable):

          Checked the OKD latest

      How reproducible:

          Always

      Steps to Reproduce:

          1. The easiest way to find the list of broken links in OKD is to run the check locally.
          2. Check out a branch against main in the openshift-docs repo and run the following command:
          3. ./scripts/prow-smoke-test.sh --validate openshift-origin    
          4. This provides many errors about xrefs referencing files that aren't included in the distro 
          5. Can check that they're broken by finding that xref in the OKD docs and trying the link, which fails.

      Actual results:

          

      Expected results:

          If a file isn't included in the OKD docs, it shouldn't be listed as an xref somewhere.

      Additional info:

      I put my output from my latest run into this spreadsheet: https://docs.google.com/spreadsheets/d/1ozDQg_J2nWEmrrO1zzAipf1hNMxYxLeBW0SxGz9kM3M/edit?gid=0#gid=0

      But whoever fixes this should still run the command locally to make sure they get everything.

              ocp-docs-bot OCP DocsBot
              rhn-support-ahoffer Andrea Hoffer
              None
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: