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: Add Ratings functionality #1038

Merged
merged 5 commits into from
Aug 9, 2024
Merged

Docs: Add Ratings functionality #1038

merged 5 commits into from
Aug 9, 2024

Conversation

jackw
Copy link
Collaborator

@jackw jackw commented Aug 7, 2024

What this PR does / why we need it:
This PR introduces a Ratings component to allow users to give feedback on how useful they find a page on our docs site.

The main docs website uses faro which I've brought across for the ride. I'm not sure if the behaviour is correct that faro is only setup and sends measurements if the cookies are agreed to (same as rudderstack).

What does it look like:
Original buttons state:
Screenshot 2024-08-07 at 10 18 43
Once rated buttons state:
Screenshot 2024-08-07 at 10 18 49

Which issue(s) this PR fixes:

Fixes #1006

Special notes for your reviewer:

@jackw jackw added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels Aug 7, 2024
@jackw jackw self-assigned this Aug 7, 2024
@jackw jackw requested a review from a team as a code owner August 7, 2024 08:20
@jackw jackw requested review from oshirohugo, tolzhabayev and sympatheticmoose and removed request for a team August 7, 2024 08:20
Copy link

github-actions bot commented Aug 7, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@@ -74,6 +74,12 @@ const config = {
sdkUrl: 'https://rsdk.grafana.com',
},
canSpamUrl: 'https://grafana-dev.com/canspam',
faroConfig: {
url: '/connect/af1fca71911a9641ebdffddb56889e97',
Copy link
Collaborator

@tolzhabayev tolzhabayev Aug 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a production key, I don't think there is one for dev

Copy link
Collaborator

@tolzhabayev tolzhabayev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally great addition, I am not 100% sure we will keep using the same way as website does but for now it's fine to attach ourselves to them. I am mostly thinking about data retention which is way higher if we just use rudderstack.

@jackw jackw merged commit c5eeffb into main Aug 9, 2024
12 checks passed
@jackw jackw deleted the jackw/docs-rating branch August 9, 2024 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation
Projects
Development

Successfully merging this pull request may close these issues.

docs: provide rating and feedback mechanism
2 participants