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.

Sign up for GitHub

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

Jump to bottom

Docs: Add documentation on how to debug backend plugins #64814

Merged
merged 3 commits into from
Mar 21, 2023
Merged

Docs: Add documentation on how to debug backend plugins #64814

merged 3 commits into from
Mar 21, 2023

Conversation

xnyo
Copy link
Member

@xnyo xnyo commented Mar 15, 2023

What is this feature?

Documentation for the changes made by grafana/grafana-plugin-sdk-go#621.

Adds instructions on how to debug backend plugins from Visual Studio Code, GoLand or other IDEs.

Why do we need this feature?

To make users aware of the new backend debug mode added to the sdk

Who is this feature for?

Backend plugin developers

Which issue(s) does this PR fix?:

Special notes for your reviewer:

@xnyo xnyo self-assigned this Mar 15, 2023
@xnyo xnyo marked this pull request as ready for review March 16, 2023 16:55
@xnyo xnyo requested review from Eve832, josmperez and a team as code owners March 16, 2023 16:55
@xnyo xnyo requested review from andresmgot, wbrowne, tolzhabayev and a team and removed request for a team March 16, 2023 16:55
andresmgot
andresmgot reviewed Mar 17, 2023
View reviewed changes
Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

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

Good content! I have some minor comments.

docs/sources/developers/plugins/development-with-local-grafana.md Outdated Show resolved Hide resolved
docs/sources/developers/plugins/development-with-local-grafana.md Outdated Show resolved Hide resolved
docs/sources/developers/plugins/development-with-local-grafana.md Outdated Show resolved Hide resolved
docs/sources/developers/plugins/development-with-local-grafana.md Outdated Show resolved Hide resolved
docs/sources/developers/plugins/development-with-local-grafana.md Outdated Show resolved Hide resolved
mckn
mckn approved these changes Mar 17, 2023
View reviewed changes
Copy link
Contributor

@mckn mckn left a comment

Choose a reason for hiding this comment

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

Added one small nit but this looks great!

docs/sources/developers/plugins/development-with-local-grafana.md Outdated Show resolved Hide resolved
@xnyo
Copy link
Member Author

xnyo commented Mar 17, 2023

Thanks for the feedback 😄 I have addressed the changes

@xnyo xnyo requested a review from andresmgot March 17, 2023 09:17
andresmgot
andresmgot approved these changes Mar 17, 2023
View reviewed changes
Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

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

LGTM! but maybe wait for a review from @josmperez to get docs team thoughts on this

josmperez
josmperez requested changes Mar 17, 2023
View reviewed changes
Copy link
Collaborator

@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.

Edits for Grafana style guidelines.

@xnyo xnyo requested a review from josmperez March 20, 2023 10:37
@xnyo
Copy link
Member Author

xnyo commented Mar 20, 2023

Thanks for the review @josmperez ! I have addressed the changes, could you please check again? Thanks 😄

@xnyo xnyo modified the milestones: 9.5.0, 9.4.8 Mar 21, 2023
@xnyo xnyo merged commit 41b0c17 into main Mar 21, 2023
@xnyo xnyo deleted the giuseppe/plugins-backend-debug-docs branch March 21, 2023 09:03
@xnyo xnyo added the backport v9.4.x Mark PR for automatic backport to v9.4.x label Mar 21, 2023
@grafanabot grafanabot mentioned this pull request Mar 21, 2023
Merged
@xnyo xnyo modified the milestones: 9.5.0, 9.4.8 Mar 21, 2023
grafanabot pushed a commit that referenced this pull request Mar 21, 2023
@xnyo @grafanabot
Docs: Add documentation on how to debug backend plugins (#64814)
dc62a94 
* Docs: Add documentation on how to debug backend plugins

* Changes from PR reviews

* PR review changes

(cherry picked from commit 41b0c17)
xnyo added a commit that referenced this pull request Mar 21, 2023
@grafanabot @xnyo
[v9.4.x] Docs: Add documentation on how to debug backend plugins (#65088
fa2a8b2 
)

Docs: Add documentation on how to debug backend plugins (#64814)

* Docs: Add documentation on how to debug backend plugins

* Changes from PR reviews

* PR review changes

(cherry picked from commit 41b0c17)

Co-authored-by: Giuseppe Guerra <giuseppe.guerra@grafana.com>
@zerok zerok modified the milestones: 9.4.x, 9.4.8, 9.5.0 Apr 12, 2023
@jdbaldry jdbaldry added the backport v9.5.x Bot will automatically open backport PR label Apr 12, 2023
@grafanabot
Copy link
Contributor

The backport to v9.5.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-64814-to-v9.5.x origin/v9.5.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 41b0c17aae9e9a0d1c72c8686bac36620410309f
# Push it to GitHub
git push --set-upstream origin backport-64814-to-v9.5.x
git switch main
# Remove the local backport branch
git branch -D backport-64814-to-v9.5.x

Then, create a pull request where the base branch is v9.5.x and the compare/head branch is backport-64814-to-v9.5.x.

@grafanabot grafanabot added the backport-failed Failed to generate backport PR. Please resolve conflicts and create one manually. label Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mckn mckn mckn approved these changes

@andresmgot andresmgot andresmgot approved these changes

@josmperez josmperez josmperez approved these changes

@Eve832 Eve832 Awaiting requested review from Eve832

@wbrowne wbrowne Awaiting requested review from wbrowne wbrowne is a code owner automatically assigned from grafana/plugins-platform-backend

@tolzhabayev tolzhabayev Awaiting requested review from tolzhabayev

Assignees

@xnyo xnyo

Labels
add to changelog area/plugins backport v9.4.x Mark PR for automatic backport to v9.4.x backport v9.5.x Bot will automatically open backport PR backport-failed Failed to generate backport PR. Please resolve conflicts and create one manually. no-backport Skip backport of PR type/docs
Projects
Plugins Platform / Grafana Community
Archived in project
Milestone
9.5.0
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@xnyo @grafanabot @mckn @andresmgot @josmperez @zerok @jdbaldry