Skip to content

Add new documentation and link for automating Visual Review feedback

This is a breakout from https://gitlab.com/gitlab-org/gitlab-ee/issues/11322#note_185770511

We should create examples of how to use environment variables to dynamically add Visual Review tools to various kinda of apps. I would recommend:

  • Rails/Middleman
  • Node/React
  • Static

Although Product may have stats on the kinds of apps we host that could inform.

Once the documentation is created, we will add a link to the Review modal. We will need text and placement from product/UX, although we don't need a full mockup if it's just updating the text.

Solution

  • Change the script to add in a comment that details you can remove part of the script in order to require the merge request ID to be provided inside of the review tool.
  • Modal added step: Step 4. Provide the merge request ID of the merge request you want to report to if needed. Read the [documentation](#linktodocumentation) to learn how to automate this step.

modal_from_merge_request_widget_button

Proposed copy for screen

Enable Visual Reviews

Follow the steps below to enable Visual Reviews inside your application.

Steps 1 and 2 (and sometimes 3) are performed once by the developer before requesting feedback. Steps 3 (if necessary), 4, and 5 are performed by the reviewer each time they perform a review.

Step 1. Copy the following script:

Step 2. Add the script inside the <head> tags of every page of your application.

Step 3. Open the Review App and provide a personal access token.

Step 4. If not previously automated by the developer, provide the ID of the merge request you want to give feedback against.

Step 5. Leave feedback in the Review App.

Edited by Evan Read