Uploaded image for project: 'Satellite'
  1. Satellite
  2. SAT-35697

Add Documentation to User Account Menu

XMLWordPrintable

    • False
    • sat-rocket
    • None
    • None
    • None
    • None

      Problem Statement

      Users of Red Hat Satellite currently lack a consistent and easily accessible path to the product's documentation. While links exist on specific pages, there is no global help or documentation link available from a predictable location. This forces users to either navigate away from their current workflow to find a documentation link or to rely on external search engines, which adds friction and reduces user efficiency. The goal is to provide a single, logical entry point to documentation that is always available, thereby improving the overall user experience and reducing the time spent searching for help.

      User Experience & Workflow

      1. A user is logged into Red Hat Satellite and working on any page (e.g., Dashboard, Jobs, Content).
      1. The user needs to reference the documentation to understand a feature or troubleshoot an issue.
      1. The user moves their cursor to the top-right corner of the screen and clicks on their username, opening the account dropdown menu.
      1. The user sees a new "Documentation" link within the dropdown menu.
      1. The user clicks on the "Documentation" link.
      1. Expected Outcome: A new browser tab opens, directing the user to the main Red Hat Satellite product documentation portal.
      1. The user can then find the information they need while keeping their current Satellite session open in the original tab.

      Requirements

      • REQ-001 (MVP): Add a new menu item labeled "Documentation" to the user account dropdown menu, positioned below the "Log Out" link.
      • REQ-002 (MVP): The "Documentation" link must open in a new browser tab.
      • REQ-003 (MVP): The URL for the link must point to the official, supported Red Hat Satellite documentation.
      • REQ-004: The new menu item should be visible to all authenticated users, regardless of their role or permissions.

      Business Impact

      Failure to undertake this feature would perpetuate the current user experience, which is less than ideal. While not a critical bug, it represents a minor usability deficit that can negatively impact the user's perception of the product's polish and ease of use. If this feature is not included, users may continue to find the product less intuitive than competitors, potentially leading to increased support requests for questions that could have been answered by documentation. It would not directly affect any specific Red Hat projects, but it represents a missed opportunity to improve customer satisfaction and reduce the burden on support teams by promoting self-service. The inclusion of this feature is a low-effort, high-impact change that significantly improves the user's interaction with the product.

              Unassigned Unassigned
              rh-ee-napathak Nakul Pathak
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: