-
Notifications
You must be signed in to change notification settings - Fork 31
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
Adds a plugin publishing best practices guide. #1158
base: main
Are you sure you want to change the base?
Conversation
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can do this separately but I think we should update this page https://grafana.com/developers/plugin-tools/publish-a-plugin/publish-a-plugin either directly here or shortly after.
Maybe remove the whole
"Before you begin" sections and update the intro text.
Otherwise it feels redundant and confusing once we add the "best practices" page.
I've added an extra bullet in the "Before you begin" section that links to this document for now. I think it's worth discussing as part of a separate PR whether this document becomes a sort of pre-requisite guide (and therefore supersedes the "Before you begin" section of the publish page). I hadn't intended for this doc to be a replacement for that initially, and I'm still not sure it makes sense to do that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some notes, generally its looking good - thanks for the contribution 🙌
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provided some comments and suggestions. Please review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just a few nits.
Co-authored-by: David Harris <[email protected]>
Co-authored-by: Joseph Perez <[email protected]>
Co-authored-by: Joseph Perez <[email protected]>
Co-authored-by: Joseph Perez <[email protected]>
Co-authored-by: Joseph Perez <[email protected]>
This guide is based on the following blog post: https://grafana.com/blog/2024/06/06/6-tips-to-improve-your-grafana-plugin-before-you-publish/