Skip to content

Improve documentation on New Frontend System in pluginsΒ #31294

@benjidotsh

Description

@benjidotsh

πŸ“œ Issue Labels

  • Please familiarize yourself with the issue labels used in this project: LABELS.md

πŸ—ƒοΈ Project Area

Unknown

πŸ”— External Integration

N/A

πŸ“ Description

While migrating our instance of Backstage to the new frontend system, we noticed that a lot of plugins lack documentation or don't even acknowledge the new frontend system. This can be confusing, especially with the existing documentation for the old/legacy frontend system.

More specifically, I would expect:

  • Installation instructions: how do I install this plugin if I don't have automatic discovery enabled? Do I need to do and/or configure something extra if automatic discovery is enabled?
    • Just like the migration of the new backend system, I would expect these to be split up into the new frontend system and the old/legacy frontend system
  • Customization options: what can I customize? What blueprints etc. can I leverage to do so?
    • This section should probably also make a distinction between the new frontend system and the old/legacy frontend system

Have you read the Code of Conduct?

Are you willing to submit PR?

No, I don't have time to work on this right now

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions