Uploaded image for project: 'OpenShift API for Data Protection'
  1. OpenShift API for Data Protection
  2. OADP-7483

[DOC] Issue with OADP docs navigation

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Major Major
    • OADP 1.6.0
    • None
    • None
    • None
    • Quality / Stability / Reliability
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • ToDo
    • Very Likely
    • 0
    • None
    • Unset
    • Unknown
    • None

      There is an issue with the navigation of the OADP docs

      https://redhat-internal.slack.com/archives/C073SBBME1M/p1771490031865389

      Two doc sets:

       

      4.18 Documentation Discrepancies

      1. Summary

      This report analyzes a reported discrepancy between the OKD 4.18 documentation and the Red Hat OpenShift Container Platform (OCP) 4.18 documentation regarding the OpenShift API for Data Protection (OADP).

      A team discussion revealed significant UI/UX and structural issues on the Red Hat portal (docs.redhat.com) that are absent from the OKD version. While OKD renders correctly, the OCP documentation suffers from navigation duplication and logical misplacement of technical sections.

      2. Conversation

      A user identified potential bugs in the Red Hat documentation for OADP, specifically noting duplicated navigation items and improper section indentation.

      Key findings from the team exchange:

      • Validation: Multiple team members confirmed that the OCP site appears "wonky," while the OKD site renders correctly.
      • Technical Root Cause: OKD and OCP use different build methods; therefore, parity in rendering is not guaranteed.
      • Known Issues: The duplication of the "Back up and restore" menu item was revealed to be a temporary (and soon to be removed) workaround for an accessibility issue.
      • Structural Error: The "Global Troubleshooting" section is incorrectly nested under "Incremental Backup Support" in the OCP version.
      • Next Steps: A JIRA ticket has been created for the content team to investigate the source-to-navigation mapping. This report will be included in the JIRA ticket to provide full context and analysis.

      3. Navigation & Structural Comparison

      Feature OKD Documentation (Target) OCP Documentation (Issue)
      Accuracy High. Navigation matches source files. Low. Disconnect between source and nav.
      Navigation Menu Unique, logically nested items. Duplicated "Back up and restore" entries.
      Section Indentation Proper hierarchy. Flat or incorrectly nested subsections.
      Troubleshooting Standalone or properly parented. Nested under "Incremental Backup Support."

      4. Major Problems with OADP OCP Docs

      The major issues identified in the OpenShift version of the OADP documentation are as follows:

      A. Navigation Redundancy

      The left-hand navigation pane displays "Back up and restore" twice. While internally documented as an accessibility workaround, it creates confusion for users and clutters the interface.

      B. Broken Information Architecture (IA)

      The most severe technical documentation error is the nesting of Global Troubleshooting. Placing it under Chapter 18: About Incremental Backup Support makes it nearly impossible for users to find general fixes, as they would assume that section only applies to incremental backups rather than the OADP operator as a whole.

      C. Formatting & Indentation

      Sections are not properly indented, leading to a "wall of text" feel in the sidebar. This prevents users from quickly scanning for high-level chapters versus granular sub-topics, degrading the overall usability of the technical resource.

      D. Build Method Divergence

      The disparity between OKD (correct) and OCP (incorrect) highlights a flaw in the OCP documentation build pipeline. Even though they share content sources, the transformation layer used for the Red Hat portal is introducing structural errors not present in the community build.

      5. Recommendations

      1. Correct the Nesting: Immediately move the Troubleshooting section to its own top-level chapter or under a more relevant parent.
      1. Clean the TOC: Remove the duplicate "Back up and restore" item as planned in the next TOC update.
      1. Audit Source Mapping: Investigate why the Pantheon build method for docs.redhat.com is failing to interpret the hierarchy that the OKD build for docs.okd.io handles correctly.

              rhn-support-anarnold A Arnold
              rhn-support-anarnold A Arnold
              Catherine Tomasko, Shruti Deshpande, Valentina Ashirova
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated: