elastic / docs-builder

https://elastic.github.io/docs-builder/
Apache License 2.0
0 stars 0 forks source link

Add support for User Feedback #47

Open bmorelli25 opened 2 weeks ago

bmorelli25 commented 2 weeks ago

Summary

We need to make it easy for users to:

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: