diff options
| author | sarahghp <sarah.groff.palermo@gmail.com> | 2019-06-13 19:14:23 -0400 |
|---|---|---|
| committer | sarahghp <sarah.groff.palermo@gmail.com> | 2019-06-13 19:14:37 -0400 |
| commit | 4607ec6c24553f71c4f2d067eb1c6006f4939771 (patch) | |
| tree | cffc628b662e3acd10e22e452f05d3ed1ab5f713 | |
| parent | 51738b76b1c400033fb69d03f42681d8010ac82a (diff) | |
| download | gitlab-ce-vrt-docs.tar.gz | |
First pass, needs more pixvrt-docs
| -rw-r--r-- | doc/ci/review_apps/img/toolbar_feeback_form.png | bin | 0 -> 157974 bytes | |||
| -rw-r--r-- | doc/ci/review_apps/index.md | 21 |
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/ci/review_apps/img/toolbar_feeback_form.png b/doc/ci/review_apps/img/toolbar_feeback_form.png Binary files differnew file mode 100644 index 00000000000..59a0abeda53 --- /dev/null +++ b/doc/ci/review_apps/img/toolbar_feeback_form.png diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md index 7b039fe6654..56f9776a354 100644 --- a/doc/ci/review_apps/index.md +++ b/doc/ci/review_apps/index.md @@ -154,6 +154,27 @@ After adding Review Apps to your workflow, you follow the branched Git flow. Tha 1. Wait for the Runner to build and deploy your web application. 1. Click on the link that provided in the merge request related to the branch to see the changes live. +### Review Toolbar + +The Review Toolbar can be added to a Review App to make it easier to post comments directly from the app back to the merge request that spawned the Review App. + + + +#### Using the Toolbar + +To use the toolbar, you will need a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) with the [API scope](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#limiting-scopes-of-a-personal-access-token). + +Comments can make use of all the markdown annotations available in merge request comment boxes. + +#### Configuring the Toolbar + +The toolbar is served through a script injected into the pages in your Review App. The base script to be included can be found by clicking the Review button in the Review App footer in the MR. + +_Screenshot of button_ +_Screenshot of open modal_ + +The base script hardcodes the project and merge request ids. You may want to consider using features of your programming language to use environment variables or another means to inject these at runtime. (And keep your eyes peeled for new features to make it even easier in upcoming releases!) + ## Limitations Review App limitations are the same as [environments limitations](../environments.md#limitations). |
