Skip to content

update Backstage READMEs #34

Closed
Closed
@Kira-Pilot

Description

@Kira-Pilot

Let's address the below feedback in our plugin README and general documentation:

  • Could we add a backstage logo or something to the README? It would help be a bit eye-catching.
  • Each plugin doesn't need to be prefixed with backstage-plugin-* since they are all in the Backstage repo. I think it'd be easier to read and understand if backstage-plugin-coder became: "Coder: Integrate Workspaces into your Backstage".
  • Does backstage-plugin-devcontainers-react need to have the -react suffix? Isn't all of Backstage in React? I think calling it -frontend would be better, since we have the -backend one. This is more of a question because I lack all context on Backstage, just a big naming nerd.
  • On the specific plugin pages, I'd recommend we don't make the titles NPM package names. We want people to link these, and seeming too technical somewhat detracts from the value one could obtain IMO.
  • Seems NPM uses the first line in the readme as the description, but maybe we want an explicit description field in the package.json.
  • Could add keywords in the package.json to make the plugins more discoverable.
  • "A collection of plugins that extend Backstage to help with developer onboarding, context switching, and automated IDE environments (remote or local)." << let's fix this wording at the root README by removing 'environments' as it's already included in 'IDE'
  • Can we link our Discord as we do on coder core: discord.gg/coder

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions