Add feedback widget

What does this MR do and why?

Adds a form to the footer of docs pages for visitors to submit feedback.

Closes #202 (closed)

image

Helpful Not helpful
image image

How to set up and validate locally

Test dev setup

  • Follow the steps in feedback.md and verify you can:
    • Access the Firebase admin console
    • View the feedback database
    • View the security Rules for the database
    • View reCAPTCHA settings

Test form functionality

  1. Visit a page on the review app, like this: https://docs.gitlab.com/review-mr-732/ci/pipelines/#pipeline-subscriptions-continue-after-user-deletion
  2. Submit a few forms with different combinations of input.
    • The form should accept: yes/no answer only; yes/no + reason only; yes/no + reason + comment
    • Comment submission disabled if comment is over 500 characters
  3. Look at the Firestore DB and verify your entries are written there. Tip: Use the query builder to filter the data down to submissions where the timestamp is greater than a minute or so prior to your form submission (use "Add to query" to add a WHERE clause).
  4. Verify form displays correctly for both desktop and mobile/small screens.

Test visibility rules

On your local site, after getting a local dev env set up, verify the following expectations:

Condition How to preview Expected behavior
Disabled via config Set feedback_enabled in config/_default/hugo.yaml to false, then run make view ❌ No form
Archived versions CI_COMMIT_REF_NAME=17.10 make view-archive ❌ No form
Missing API keys
Test in a different browser than you used for creating your debug token.
FIREBASE_API_KEY="" RECAPTCHA_SITE_KEY="" make view ✅ Form visible, but it will not post to the DB; error appears on submit.

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Sarah German

Merge request reports

Loading
Loading