-
Notifications
You must be signed in to change notification settings - Fork 59
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
Adding link to the documentation in the plugin catalog page #343
Comments
cc: @ivanahuckova |
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 🙂 |
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 |
Thanks for the hint @ivanahuckova . I updated the plugin.json and here is the PR: |
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? |
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 |
Thank you @ivanahuckova for finishing both PR. I will now close this issue !! |
After search OR installing the plugin inside the web UI, it does not show a link to the documentation.
It will be good to have a link to the official documentation (reference e.g. the infinity plugin):
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.
The text was updated successfully, but these errors were encountered: