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: provide rating and feedback mechanism #1006

Closed
sympatheticmoose opened this issue Jul 12, 2024 · 6 comments · Fixed by #1038
Closed

docs: provide rating and feedback mechanism #1006

sympatheticmoose opened this issue Jul 12, 2024 · 6 comments · Fixed by #1038
Assignees
Labels
type/docs Changes only affect the documentation

Comments

@sympatheticmoose
Copy link
Contributor

Similar to what we have on the main grafana docs

Screenshot 2024-07-12 at 10 51 46

It would be useful to be able to gather insights from users on which pages are more/less helpful and directly encourage feedback.

A quick search suggests no docusaurus plugin exists for this and instead the recommendation seems to be to swizzle

@sympatheticmoose sympatheticmoose added the type/docs Changes only affect the documentation label Jul 12, 2024
@derek-cadzow
Copy link

@josmperez Is this our task and should it stay in our repo/project?

@josmperez
Copy link
Contributor

@josmperez Is this our task and should it stay in our repo/project?

This task will require engneering resources to complete and none have yet been assigned; however, @jdbaldry is aware of this to-do and he may be taking a look at it in the future (or someone on the plugins team could be assigned to it).

@jdbaldry
Copy link
Member

It's not something that I'll be actively working on in the current quarter for sure.

Here's a starting point for the implementation in the website: https://github.com/grafana/website/blob/bc01d9453359ad66e97a70a5753d828817d70c7f/assets/js/app/components/docs.js#L160-L234

@sympatheticmoose
Copy link
Contributor Author

I'd expect we'd own it in the plugins team, but would want to collab as appropriate to leverage whats already in place. Ideally we'd want to be able to measure consistently as there are some journeys which will span both the grafana docs and the dev docs

@jdbaldry
Copy link
Member

jdbaldry commented Aug 1, 2024

In theory, you can use the same code right? You'd just need to hook up an element similar to ours https://github.com/grafana/website/blob/ac8baa261059cf8670d5ecc40cdf755a10cbf840/layouts/partials/docs/rating.html

@jdbaldry
Copy link
Member

jdbaldry commented Aug 1, 2024

The challenge will be how you test it without the full website build and also how we ensure that changes in the website don't break things for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Changes only affect the documentation
Projects
Development

Successfully merging a pull request may close this issue.

5 participants