grafana / plugin-tools

Create Grafana plugins with ease.
https://grafana.com/developers/plugin-tools/
Apache License 2.0
55 stars 27 forks source link

README: Update package list #872

Closed leventebalogh closed 1 month ago

leventebalogh commented 3 months ago

What changed?

Updated the structure of the main README (view the new version →), to make it a bit easier to scan. (This can be totally opinionated, so it's more like a conversation starter.)

Before After
Screenshot 2024-04-11 at 11 15 23 Screenshot 2024-04-17 at 09 12 34
jackw commented 3 months ago

I personally prefer the table as I think it looks tidier and the buttons aren't between the name and description which is jarring to read.

I think referring to the packages by their npm name is a nice addition as is updating the descriptions.

leventebalogh commented 3 months ago

Those are good inputs - just to make sure I understand correctly what you are suggesting is to go back to the table view, but use the names of the packages (e.g. @grafana/plugin-e2e) and also go with the updated descriptions, right? (How do you feel about getting rid of the readme column, and turning the package names into a link?)

github-actions[bot] commented 3 months ago

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

leventebalogh commented 3 months ago

What do you think about it now @jackw?

leventebalogh commented 3 months ago

Okie dokie, I'll revive them :)

CLAassistant commented 1 month ago

CLA assistant check
All committers have signed the CLA.