search

backstage / community-plugins

Community plugins for Backstage
Apache License 2.0
113 stars 84 forks source link

Readme files organization #197

Open quichef opened 2 months ago

quichef commented 2 months ago

Plugin Name

All

🔖 Feature description

Hey, Currently when you dive into a workspace, let's say : https://github.com/backstage/community-plugins/tree/main/workspaces/sonarqube you land on a not-so-pretty Readme, as the readmes has been moved into a subfolder. Wondering if we could move some readmes, and huh, i'd be interested in trying to help 😄

🎤 Context

n/a

✌️ Possible Implementation

No response

👀 Have you spent some time to check if this feature request has been raised before?

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

awanlin commented 2 months ago

As the author of the Azure DevOps and Linguist plugins I'd prefer to keep the structure and create a nice README at this level as it would allow me to create a nice end-to-end flow for installation as they both have frontend and backend plugins. This has been a constant installation problem and this give us the chance to improve it. 🚀

awanlin commented 2 months ago

This repo is pretty new and I suspect plugin Owners are busy looking things over and thinking about the best way forward, I know for sure I am.

freben commented 2 months ago

@awanlin So then the individual plugin readmes could just say "See the main readme" linking to that?

Only caveat is that that will be the contents that people see on npm for the package. Slightly awkward, but not too bad.

awanlin commented 2 months ago

Honestly haven't had the chance to think it through fully. My thinking is that "most" Adopters come from the Plugin Directory so from there we could like to the Workspace README easily. For the separate package README they could stay the same but link to the workspace README and then over time perhaps have them focused on more specific concerns of the plugin itself.

quichef commented 2 months ago

I think that is pretty valid Honestly wanted to discuss and check a bit before opening a random PR 😅

So eventually plugin owners will manage at plugin level?

awanlin commented 2 months ago

Yeah, that's why I posted, wanted to share my thoughts 👍