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

Add lightweight feedback capability to each page in the docs #3118

Open
1 of 2 tasks
hillaryfraley opened this issue Apr 15, 2021 · 1 comment
Open
1 of 2 tasks

Add lightweight feedback capability to each page in the docs #3118

hillaryfraley opened this issue Apr 15, 2021 · 1 comment
Labels
site development Improves docs.sensu.io functionality

Comments

@hillaryfraley
Copy link
Contributor

Description

We added a one-click rating scale to the docs in #3076 and moved it up to the sidebar in #3115.

We would like to enhance this with a lightweight feedback form that appears for any rating except five hearts so we can capture users' thoughts about any difficulties they have with any particular docs pages.

Category

This is an issue with:

  • bug (bug in site build, layout, or functionality)
  • enhancement (add new or updated site functionality)

Affected pages

All pages

Expected behavior

When users provide any rating except five hearts, they see a brief feedback form that requests a few lines of anonymous feedback about what went wrong, what to improve, etc.

When a user submits feedback with this form, the feedback is saved such that:

  • The feedback is connected with the page from which it was submitted
  • The Reliability team can access the feedback and act on it

Current behavior

Users must open a GitHub issue or PR to share feedback about a docs page.

Changes needed

Add the form -- I've tinkered with an onclick event to add something like "Thank you!" but didn't get any further.

Additional context

I think we should aim for something like the form Microsoft uses when users click thumbs up/thumbs down: https://docs.microsoft.com/en-us/dynamics365/customer-service/learning-catalog

@hillaryfraley hillaryfraley added this to the Site development milestone Sep 23, 2021
@calebhailey calebhailey added the site development Improves docs.sensu.io functionality label Sep 23, 2021
@hillaryfraley hillaryfraley removed this from the Site development milestone Sep 23, 2021
@calebhailey calebhailey added this to the 6.6.0 milestone Sep 23, 2021
@hillaryfraley
Copy link
Contributor Author

another good example with thumbs up/down and optional comment field (scroll to bottom of page): https://developer.aiven.io/

@hillaryfraley hillaryfraley modified the milestones: 6.6.0, 6.next Nov 23, 2021
@hillaryfraley hillaryfraley removed this from the 6.next milestone Feb 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site development Improves docs.sensu.io functionality
Projects
None yet
Development

No branches or pull requests

2 participants