Configure custom TechDocs add-ons by using extension blueprints

In Red Hat Developer Hub 2.1, the new front-end system wires TechDocs add-ons through extension blueprints instead of the legacy dynamicPlugins.frontend.<plugin>.techdocsAddons configuration.

A plugin creator registers each add-on in code by using AddonBlueprint from @backstage/plugin-techdocs-react/alpha. The blueprint produces an extension ID in the format addon:techdocs/<add-on_name>, which is the identifier that you reference from application configuration.

For example, the contributed TechDocs add-on package registers the following extension IDs:

  • addon:techdocs/expandable-navigation
  • addon:techdocs/report-issue
  • addon:techdocs/text-size
  • addon:techdocs/light-box

TechDocs add-ons are auto-discovered and enabled by default. To disable an add-on, or to override its configuration, reference its extension ID in the app.extensions section of your app-config.yaml file. For example:

app:
  extensions:
    - addon:techdocs/example: false # Disable the add-on by its extension ID

For information about creating a custom add-on, see Create a TechDocs add-on.