-
Epic
-
Resolution: Unresolved
-
Major
-
None
-
None
-
None
-
Make backend dynamic plugin feature well-documented and easy to use on upstream
-
M
-
False
-
-
False
-
-
In Progress
-
RHDHPLAN-231 - Make backend dynamic plugin feature well-documented and easy to use on upstream
-
QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
-
0% To Do, 50% In Progress, 50% Done
-
-
EPIC Goal
Make backend dynamic plugins well-documented and easy to use on upstream
Background/Feature Origin
In the upstream package which is the basis of the dynamic backend plugins feature ([backend-dynamic-feature-service|https://github.com/davidfestal/backstage/tree/master/packages/backend-dynamic-feature-service]), the documentation was minimal, especially because on a number of aspects it was used only by RHDH and did require some specific changes to upstream plugins in order be exported and used as dynamic plugins.
So in the readme for example, it was still spoken of as being in an experimental state, and testing it on an upstream backstage installation was not easy.
Now that the code itself is much more matured, and integrates much better with the rest of the upstream ecosystem, we should change for example update the Readme, to remove the experimental mention, and add some more documentation that would allows upstream users to use it or test it, and also possibly provide createApp templates that would directly include the dynamic plugins support in a created Backstage app.
Why is this important?
It is important in order to raise awareness about this feature, its value and its ease of use, inside the upstream backstage community.
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>