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

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

Closed
usmangt opened this issue Aug 2, 2024 · 8 comments
Closed

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

usmangt opened this issue Aug 2, 2024 · 8 comments
Labels
type/docs Improvements or additions to documentation

Comments

@usmangt
Copy link
Contributor

usmangt commented Aug 2, 2024

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 usmangt added the type/docs Improvements or additions to documentation label Aug 2, 2024
@usmangt
Copy link
Contributor Author

usmangt commented Aug 2, 2024

cc: @ivanahuckova

@ivanahuckova
Copy link
Member

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
Copy link
Member

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
Copy link
Contributor Author

usmangt commented Aug 5, 2024

Thanks for the hint @ivanahuckova . I updated the plugin.json and here is the PR:
#344

@usmangt
Copy link
Contributor Author

usmangt commented Aug 5, 2024

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
Copy link
Member

ivanahuckova commented Aug 5, 2024

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
Copy link
Contributor Author

usmangt commented Aug 5, 2024

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
#346

@usmangt
Copy link
Contributor Author

usmangt commented Aug 6, 2024

Thank you @ivanahuckova for finishing both PR.

I will now close this issue !!

@usmangt usmangt closed this as completed Aug 6, 2024
@github-project-automation github-project-automation bot moved this to Complete in OSS Big Tent Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
Status: Complete
Development

No branches or pull requests

2 participants