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

Adds a plugin publishing best practices guide. #1158

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

tomglenn
Copy link
Contributor

@tomglenn tomglenn commented Oct 2, 2024

@tomglenn tomglenn requested a review from a team as a code owner October 2, 2024 13:44
@tomglenn tomglenn requested review from oshirohugo and removed request for a team October 2, 2024 13:44
Copy link

github-actions bot commented Oct 2, 2024

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.

@tomglenn tomglenn added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels Oct 2, 2024
Copy link
Collaborator

@tolzhabayev tolzhabayev left a 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.

@tomglenn
Copy link
Contributor Author

tomglenn commented Oct 4, 2024

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.

Copy link
Contributor

@sympatheticmoose sympatheticmoose left a 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 🙌

@tolzhabayev tolzhabayev self-requested a review October 7, 2024 09:21
Copy link

@usmangt usmangt left a 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

Copy link
Contributor

@josmperez josmperez left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation
Projects
Status: 🔬 In review
Development

Successfully merging this pull request may close these issues.

6 participants