-
Feature
-
Resolution: Unresolved
-
Major
-
None
-
None
-
None
-
False
-
-
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.