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 support for User Feedback #47

Open
bmorelli25 opened this issue Nov 11, 2024 · 0 comments
Open

Add support for User Feedback #47

bmorelli25 opened this issue Nov 11, 2024 · 0 comments

Comments

@bmorelli25
Copy link
Member

Summary

We need to make it easy for users to:

  • Make a contribution to the docs
  • Tell us when they like/dislike our docs

We can do this by providing a place, directly in the docs, that links users to relevant documentation source files, and gives users the ability to send feedback directly to a technical writer.

Examples:

GitHub API docs
Image

Buildkite docs
Image

V1/V2 Feedback

We have a feedback widget in V1/V2 that works like this:

  1. User submits feedback
  2. docs.elastic.co API request (validation of data)
  3. Remote function API request
  4. Data added to Big Query
  5. Data manually added to ES

Downsides:

  • Manual
  • Users can't add context to their feedback (can only select yes/no)
  • No way for us to notify users that their feedback was implemented
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants