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

docs: update permissions and provisioning #371

Merged
merged 5 commits into from
Oct 1, 2024
Merged

Conversation

gwdawson
Copy link
Member

@gwdawson gwdawson commented Oct 1, 2024

when implementing the app token auth, i forgot to add the required permissions to the documentation. this pr lists all required permissions when using github app auth

this pr also updates the provisioning section of the docs to include app auth examples.

Before (permissions):
https://grafana.com/docs/plugins/grafana-github-datasource/latest/setup/token/#permissions

After (permissions):
Screenshot 2024-10-01 at 11 17 04

Before (provisioning):
https://grafana.com/docs/plugins/grafana-github-datasource/latest/setup/provisioning/

After (provisioning):
Screenshot 2024-10-01 at 12 31 44

Fixes #370

@gwdawson gwdawson self-assigned this Oct 1, 2024
@gwdawson gwdawson requested a review from a team as a code owner October 1, 2024 10:18
@zoltanbedi
Copy link
Member

This looks good.

Can you please also update the readme.md? Can you also please add an example for provisioning? That way we can close this issue #370

@gwdawson gwdawson changed the title docs: update permissions for app tokens docs: update permissions and provisioning Oct 1, 2024
@zoltanbedi
Copy link
Member

In the readme can you please update this section as well? https://github.com/grafana/github-datasource?tab=readme-ov-file#access-token-permissions and also remove the first question from the faq? Thanks 🙏

@gwdawson gwdawson requested a review from zoltanbedi October 1, 2024 13:09
@gwdawson
Copy link
Member Author

gwdawson commented Oct 1, 2024

@zoltanbedi as discussed in slack, i have removed all the duplicated documentation from the readme.

Copy link
Member

@zoltanbedi zoltanbedi left a comment

Choose a reason for hiding this comment

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

LGTM, thank you ⭐

@gwdawson gwdawson merged commit 4f41bb9 into main Oct 1, 2024
10 checks passed
@gwdawson gwdawson deleted the gareth/app-token-docs branch October 1, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GitHub App Permissions and provisioning
2 participants