Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update Backstage READMEs #34

Closed
8 tasks done
Kira-Pilot opened this issue Mar 15, 2024 · 3 comments · Fixed by #75
Closed
8 tasks done

update Backstage READMEs #34

Kira-Pilot opened this issue Mar 15, 2024 · 3 comments · Fixed by #75
Assignees

Comments

@Kira-Pilot
Copy link
Member

Kira-Pilot commented Mar 15, 2024

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
@Parkreiner
Copy link
Collaborator

Just added a PR that addresses most of these. Not sure what @bpmct 's plans for Loom were (I could've sworn he mentioned recording some soon), but I'm going to look into the badges once I'm back from my lunch break

@Parkreiner
Copy link
Collaborator

Forgot to mention this about the badges, but I'd prefer for us to tighten up our test coverage a little more first before we have badges that show metrics and things like that

I don't think there would be any shame in adding them early – you could say that it's us being super-transparent, since we're not even on version 0.1.0 yet – but my personal preference would be to wait a little bit longer until we have a better baseline

@Parkreiner
Copy link
Collaborator

Going to turn the last two items into separate issues, but they should get done relatively quickly
Going to be working on tests today, and I'm going to finish up editing the main Coder plugin promo video tomorrow, which I think we can repurpose here. Then there would just be the Devcontainers plugin left

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants