Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-5121

Impossible to report a documentation issue from selected documentation content

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Critical Critical
    • 1.3.2
    • 1.2
    • TechDocs
    • None
    • 1
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide
      Previously, the feature to report a documentation (techdoc) issue didn't work. When the user selected a text in the documentation, it showed a huge icon rather than a tooltip button.

      With this update, the user can select content in the documentation, and click the tooltip button to report a documentation issue.
      Show
      Previously, the feature to report a documentation (techdoc) issue didn't work. When the user selected a text in the documentation, it showed a huge icon rather than a tooltip button. With this update, the user can select content in the documentation, and click the tooltip button to report a documentation issue.
    • Bug Fix
    • Done
    • RHDH F&UI plugins 3266
    • Low
    • Customer Facing

      Description of problem:

      When a RHDH user selects a text in the techdocs, a huge icon is displayed instead of the expected "Report an issue" clickable tooltip.

      See RHDHBUGS-97 or https://github.com/janus-idp/backstage-showcase/pull/2024 for some screenshots and recordings.

      Prerequisites (if any, like setup, operators/versions):

      RHDH, at least 1.2+ maybe already with 1.0 and 1.1 (not tested).

      Steps to Reproduce

      1. Import a catalog entity with techdocs
      2. Navigate to the techdocs
      3. Select some text from the content

      Actual results:

      A huge icon is displayed.

      Expected results:

      A small clickable tooltip should be displayed to report a doc issue.

      Reproducibility (Always/Intermittent/Only Once):

      Always (with RHDH, not Backstage)

      Build Details:

      At least all 1.2 releases, and later

      Additional info (Such as Logs, Screenshots, etc):

              cjerolim Christoph Jerolimov
              cjerolim Christoph Jerolimov
              RHIDP - Frontend Plugins & UI
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: