summaryrefslogtreecommitdiff
path: root/doc/ci
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-11-22 00:06:08 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2019-11-22 00:06:08 +0000
commit157f9a451a428f66666ba85d8b880df78aff6cc4 (patch)
tree7c38cacafb9720d144a6add0a170a07a7cc376f6 /doc/ci
parent7f15e74dae019ac96c65ec769eae2d67aae65a8c (diff)
downloadgitlab-ce-157f9a451a428f66666ba85d8b880df78aff6cc4.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/ci')
-rw-r--r--doc/ci/review_apps/index.md32
1 files changed, 21 insertions, 11 deletions
diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md
index b69562faad7..0da1228aa53 100644
--- a/doc/ci/review_apps/index.md
+++ b/doc/ci/review_apps/index.md
@@ -163,6 +163,13 @@ that spawned the Review App.
### Configuring Visual Reviews
+Ensure that the `anonymous_visual_review_feedback` feature flag is enabled.
+Administrators can enable with a Rails console as follows:
+
+```ruby
+Feature.enabled(:anonymous_visual_review_feedback)
+```
+
The feedback form is served through a script you add to pages in your Review App.
If you have [Developer permissions](../../user/permissions.md) to the project,
you can access it by clicking the **Review** button in the **Pipeline** section
@@ -221,6 +228,19 @@ NOTE: **Note:**
Future enhancements [are planned](https://gitlab.com/gitlab-org/gitlab/issues/11322)
to make this process even easier.
+### Determining merge request ID
+
+The visual review tools retrieve the merge request ID from the `data-merge-request-id`
+data attribute included in the `script` HTML tag used to add the visual review tools
+to your review app.
+
+​After determining the ID for the merge request to link to a visual review app, you
+can supply the ID by either:​​
+
+- Hardcoding it in the script tag via the data attribute `data-merge-request-id` of the app.
+- Dynamically adding the `data-merge-request-id` value during the build of the app.
+- Supplying it manually through the visual review form in the app.
+
### Using Visual Reviews
After Visual Reviews has been [enabled](#configuring-visual-reviews) for the
@@ -231,25 +251,15 @@ the bottom-right corner.
To use the feedback form:
-1. Create a [personal access token](../../user/profile/personal_access_tokens.md)
- with the API scope selected.
-1. Paste the token into the feedback box when prompted. If you select **Remember me**,
- your browser stores the token so that future visits to Review Apps at the same URL
- will not require you to re-enter the token. To clear the token, click **Log out**.
1. Make a comment on the visual review. You can make use of all the
[Markdown annotations](../../user/markdown.md) that are also available in
merge request comments.
+1. Submit your feedback anonymously or add your name.
1. Finally, click **Send feedback**.
After you make and submit a comment in the visual review box, it will appear
automatically in the respective merge request.
-TIP: **Tip:**
-Because tokens must be entered on a per-domain basis and they can only be accessed
-once, different review apps will not remember your token. You can save the token
-to your password manager specifically for the purpose of Visual Reviews. This way,
-you will not need to create additional tokens for each merge request.
-
## Limitations
Review App limitations are the same as [environments limitations](../environments.md#limitations).