search

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

Adding link to the documentation in the plugin catalog page #343

Closed usmangt closed 2 months ago

usmangt commented 2 months ago

After search OR installing the plugin inside the web UI, it does not show a link to the documentation.

image

It will be good to have a link to the official documentation (reference e.g. the infinity plugin):

image

This will help the users to understand and use it correctly and also help us to make the docs better for any suggestions or future improvements.

usmangt commented 2 months ago

cc: @ivanahuckova

ivanahuckova commented 2 months ago

Hi @usmangt! I checked and it seems that infinity specifies it in its plugin json: https://github.com/grafana/grafana-infinity-datasource/blob/main/src/plugin.json. Feel free to add it to github plugin json: https://github.com/grafana/github-datasource/blob/main/src/plugin.json 🙂

ivanahuckova commented 2 months ago

Also it looks like it is using https://github.com/grafana/github-datasource/blob/main/README.md for overview. I am wondering, if we should change its content to what you created in https://github.com/grafana/github-datasource/blob/main/docs/sources/_index.md

usmangt commented 2 months ago

Thanks for the hint @ivanahuckova . I updated the plugin.json and here is the PR: https://github.com/grafana/github-datasource/pull/344

usmangt commented 2 months ago

Also it looks like it is using https://github.com/grafana/github-datasource/blob/main/README.md for overview. I am wondering, if we should change its content to what you created in https://github.com/grafana/github-datasource/blob/main/docs/sources/_index.md

Good point. Yes, that will be helpful for users.

How about if we simply put a new link in the current readme.md file "Link to the Documentation" and that way we do not need to change that much?

ivanahuckova commented 2 months ago

Yes, I think that is a good idea! Having a single source of truth so we don't have to update data source docs when something changes at 2 places.

usmangt commented 2 months ago

Yes, I think that is a good idea! Having a single source of truth so we don't have to update data source docs when something changes at 2 places.

Created this PR https://github.com/grafana/github-datasource/pull/346

usmangt commented 2 months ago

Thank you @ivanahuckova for finishing both PR.

I will now close this issue !!