Skip to content

chore: update docs and package.json files for discoverability #36

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

Merged
merged 10 commits into from
Mar 15, 2024

Conversation

Parkreiner
Copy link
Member

@Parkreiner Parkreiner commented Mar 15, 2024

Addresses the majority of the issues from #34

Changes made

  • Added main banner image to the top-level README
  • Updated all package.json files to include description and keywords properties
    • Felt like I didn't want to spam keywords, so I followed the official Backstage repo's lead on this
  • Updated all titles for the plugin READMEs to be more human-friendly and less technical
  • Caught a couple more places where "Dev Containers" wasn't two words in the docs yet

Notes

@Parkreiner Parkreiner requested review from Kira-Pilot and bpmct March 15, 2024 16:01
@Parkreiner Parkreiner self-assigned this Mar 15, 2024
@@ -1,10 +1,12 @@
<img src="./images/banner-image.png" alt="Official Coder plugins for Backstage" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks awesome!

# Backstage Plugins

A collection of plugins that extend [Backstage](https://backstage.io) to help with developer onboarding, context switching, and automated IDE environments (remote or local).
A collection of plugins that extend [Backstage](https://backstage.io) to help with developer onboarding, context switching, and automated IDEs (remote or local).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - I just saw this myself

@@ -1,5 +1,6 @@
{
"name": "@coder/backstage-plugin-devcontainers-react",
"description": "Automatically launch fully-contained dev environments with development containers (dev containers), right from Backstage!",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the parentheses here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, could probably remove it for the NPM description

@Parkreiner Parkreiner merged commit 606412f into main Mar 15, 2024
@Parkreiner Parkreiner deleted the mes/doc-update-2 branch March 15, 2024 17:32
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 this pull request may close these issues.

2 participants