EPIC Goal

Goals

Provide a guide explaining how to create Backstage plugins with our best practices and software templates to get started quickly with frontend plugin and backend plugin.

This will be used for any teams within Red Hat who would like to create plugins, customers who need to create custom plugin for homegrown internal solutions and any one in the community (and partners) that need to create plugins.

Documentation

• Frontend plugin
  • Different types of displays (page, main card, overview card, user settings, admin page)
  • How to add permission (RBAC)
  • How to add localization
  • How to add analytics
  • UX Best practices and consistent experience
• Backend plugin
  • How to secure the APIs
  • How to generate the OpenAPIs specs
  • How to persist data in the Backstage database
• Dynamic plugin
  • Quick explanation and refer to the existing documentation
• Plugin Testing

Software Templates

Once the guide/documentation is complete, we should provide 2 software templates for frontend plugin and backend plugin containing all the best practices so any customers or anyone in the community can start a new plugin with a few clicks in seconds.

Background/Feature Origin

Why is this important?

User Scenarios

Dependencies (internal and external)

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>