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

Be able to add Techdocs Add-ons to Techdocs

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • Icon: Feature Feature
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • False

      Feature Overview (aka. Goal Summary)

      The Techdocs feature can be extended with add-ons. https://backstage.io/docs/features/techdocs/addons/

      Goals (aka. expected user outcomes)

      Customers would like to be able to use some add-ons such as mermaid (https://www.npmjs.com/package/backstage-plugin-techdocs-addon-mermaid) into RHDH.

      Requirements (aka. Acceptance Criteria):

      • 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.

      Documentation Considerations

      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.

            rh-ee-pknight Patrick Knight
            jfargett@redhat.com Christophe Fargette
            RHIDP - Plugins
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: