diff options
| author | Sarah Groff Hennigh-Palermo <sarah.groff.palermo@gmail.com> | 2019-06-14 10:48:45 +0000 |
|---|---|---|
| committer | sarahghp <sarah.groff.palermo@gmail.com> | 2019-06-14 14:46:03 -0400 |
| commit | 770fe0aa7a604f8fedd1c87b623c50fdb090d7ff (patch) | |
| tree | cb87e0231927e32c90a7d076ba21a55e453bde7f | |
| parent | a01ae3b131f99e7899fa23a4d4f944fa06f4a1f1 (diff) | |
| download | gitlab-ce-770fe0aa7a604f8fedd1c87b623c50fdb090d7ff.tar.gz | |
Apply suggestions from review
| -rw-r--r-- | doc/ci/review_apps/index.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md index 4060993bf51..9b827af98b0 100644 --- a/doc/ci/review_apps/index.md +++ b/doc/ci/review_apps/index.md @@ -156,24 +156,35 @@ After adding Review Apps to your workflow, you follow the branched Git flow. Tha ### 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. +The Review Toolbar can be added to a Review App to make it possible to post comments +directly from the app back to the merge request that spawned the Review App. + +For example, a form like the following can be made to post the contents of the +text field into the discussion thread of a merge request:  #### 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). +To use the toolbar, you will need a [personal access token](../../user/profile/personal_access_tokens.md) with the [API scope](../../user/profile/personal_access_tokens.md#limiting-scopes-of-a-personal-access-token). -Comments can make use of all the markdown annotations available in merge request comment boxes. +Comments can make use of all the [Markdown annotations](../../user/markdown.md) +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. +The toolbar is served through a script you add to pages in your Review App. +The contents of the script can be found by clicking the **Review** button in the +Review App footer in the MR.   -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!) +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. + +Future enhancements will make this process even easier. ## Limitations |