-
Epic
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
-
Start a dynamic plugin FAQ/cookbook
-
False
-
-
False
-
RHIDP-3966Dynamic plugins developer documentation
-
To Do
-
RHIDP-3966 - Dynamic plugins developer documentation
-
QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
-
-
EPIC Goal
Start a home for smaller, more targeted guides for dynamic plugin use cases.
Background/Feature Origin
Why is this important?
There's quite a lot of things that can be solved using dynamic plugins but it's not always clear how to do so. It'd be good to start an FAQ or cookbook that covers various topics such as these examples:
- How to make a scaffolder field extension
- How to make a custom action
- How to load a username transformer when ingesting catalog entities
- How to configure up a dynamic plugin project to publish to an npm registry
- How to properly migrate a plugin project and your local environment to Yarn 3.x
User Scenarios
- as a user I may need some slight direction to figure out how to solve a problem via a dynamic plugin
- as a user I may need some code examples to help get me started on a task that involves using or creating a dynamic plugin.
Dependencies (internal and external)
Acceptance Criteria
- There's a public URL that can be shared with anyone looking for guidance
- The cookbook/FAQ follows a consistent format that can be easily added to in the future