grafana / github-datasource

Grafana data source plugin using the Github API to retrieve and visualize Github data.
https://grafana.com/grafana/plugins/grafana-github-datasource/
Apache License 2.0
242 stars 53 forks source link

docs: update permissions and provisioning #371

Closed gwdawson closed 5 days ago

gwdawson commented 5 days ago

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 https://github.com/grafana/github-datasource/issues/370

zoltanbedi commented 5 days ago

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

zoltanbedi commented 5 days ago

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 commented 5 days ago

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