• Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • 1.5.0
    • None
    • TechDocs
    • None
    • Be able to add Techdocs Add-ons to Techdocs
    • False
    • Hide

      None

      Show
      None
    • False
    • RHIDP-4713Be able to add Techdocs Add-ons to Techdocs
    • Done
    • RHIDP-4713 - Be able to add Techdocs Add-ons to Techdocs
    • QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
    • 0% To Do, 0% In Progress, 100% Done
    • Add the ability to optionally add Techdocs add-ons to Techdocs.
    • Enhancement
    • Rejected

      EPIC Goal

      The Techdocs feature can be extended with add-ons. https://backstage.io/docs/features/techdocs/addons/ and there are some customers who would like the ability to use this feature.

      Background/Feature Origin

      Why is this important?

      This will allow users the ability to use different tech docs add ons that will allow them the ability to further customize their tech docs experience.

      User Scenarios

       

      • As an administrator, I want to be able to add Techdocs add-ons to RHDH
      • As an administrator, I want to be able to remove Techdocs add-ons from RHDH
      • As a user, I want to be able to see my documentation in RHDH with additional features provided by my administrator.
      • As a developer, I want to understand how to create an add-on.

      Dependencies (internal and external)

      Docs considerations for the feature:

      An administrator should be able to find all the information needed to manage Techdocs add-ons in RHDH. Add/Remove an add-on.

      A user or a documentation writer should know what syntax to use in the Mkdocs format to use the add-ons in their documentation

      A developer should be able to find the information to create and publish an add-on for Techdocs.

      Acceptance Criteria

      Release Enablement/Demo - Provide necessary release enablement details
      and documents

      DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Upstream documentation merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Downstream build attached to advisory: <link to errata>

      QE - Test plans in Playwright: <link or reference to playwright>

      QE - Automated tests merged: <link or reference to automated tests>

      DOC - Downstream documentation merged: <link to meaningful PR>

              oandriie Aleksander Andriienko
              rh-ee-pknight Patrick Knight
              RHIDP - Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: