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

Support to register techdocsPlugin.provide(createTechDocsAddonExtension( for dynamic plugin

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • 1.5.0
    • None
    • TechDocs
    • None
    • 5
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide
      = techdocsAddons configuration for dynamic plugins

      With this update, {product-short} introduces the techdocsAddons configuration option for a dynamic plugin's frontend configuration. This feature allows dynamic plugins to export one or more components as TechDocs addons, enhancing the TechDocs experience. Addons can be configured using props to modify their behavior, such as manipulating a TechDocs site's Document Object Model (DOM).

      For more information, see <link to docs>.
      Show
      = techdocsAddons configuration for dynamic plugins With this update, {product-short} introduces the techdocsAddons configuration option for a dynamic plugin's frontend configuration. This feature allows dynamic plugins to export one or more components as TechDocs addons, enhancing the TechDocs experience. Addons can be configured using props to modify their behavior, such as manipulating a TechDocs site's Document Object Model (DOM). For more information, see <link to docs>.
    • Feature
    • Done
    • RHDH Plugins 3269

      Story

      As a user of RHDH, I want to add different techdocs addons so that I can customize techdocs experience.

      Add new configuration option like:

      dynamicPlugins
  frontend:
    backstage.plugin-techdocs-addon-example:
      techdocsAddons:
        - ExampleAddon
          config:
            props: ... # optional, React props to pass to the addon

      Where the plugin exports it's techdocs field extension component like:

      export const ExampleAddon = techdocsPlugin.provide(
  createTechDocsAddonExtension({
    name: "ExampleAddon",
    location: TechDocsAddonLocations.Content,
    component: ExampleTestAddon,
  }),
);

      Dependencies and Blockers

      QE impacted work

      Documentation impacted work

      Acceptance Criteria

      • Add techdocs addons mountpoint
      • Convert techdocs-module-addons-contrib which contains techdocs extensions:
        • LightBox
        • ReportIssue
        • TextSize
        • ExpandableNavigation

      upstream documentation updates (design docs, release notes etc)

      Technical enablement / Demo

              rh-ee-dzemanov Dominika Zemanovicova
              rh-ee-dzemanov Dominika Zemanovicova
              RHIDP - Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: