diff options
author | Mike Lewis <mlewis@gitlab.com> | 2019-03-07 20:23:06 +0000 |
---|---|---|
committer | Mike Lewis <mlewis@gitlab.com> | 2019-03-07 20:23:06 +0000 |
commit | 5566809c977ad6d61b6f16aad6135e6980e26b1f (patch) | |
tree | 875ba7e3c4ca7f1615f7dc3aee1357de4b26d24c /doc | |
parent | 91401004a92a2f21cf5f6e761ac8421c59ad09b0 (diff) | |
parent | dbd7309a16bd3abc6c586b6c2df2beb317cfef95 (diff) | |
download | gitlab-ce-5566809c977ad6d61b6f16aad6135e6980e26b1f.tar.gz |
Merge branch 'reply-to-comment-documentation' into 'master'
Created documentation for replying to comments
See merge request gitlab-org/gitlab-ce!25633
Diffstat (limited to 'doc')
-rw-r--r-- | doc/user/discussions/index.md | 39 |
1 files changed, 21 insertions, 18 deletions
diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index 02bfd2bec7a..90936034fea 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -10,32 +10,35 @@ You can leave a comment in the following places: - commits - commit diffs -The comment area supports [Markdown] and [quick actions]. Every individual -comment can be [turned into a discussion](#start-a-discussion-by-replying-to-a-non-discussion-comment) -One can also edit their own comment at any time, and anyone with [Maintainer access level][permissions] or -higher can also edit a comment made by someone else. +There are standard comments, and you also have the option to create a comment +in the form of a threaded discussion. A comment can also be [turned into a discussion](#start-a-discussion-by-replying-to-a-non-discussion-comment) +when it receives a reply. -You could also reply to the notification email in order to reply to a comment, -provided that [Reply by email] is configured by your GitLab admin. This also -supports [Markdown] and [quick actions] as if replied from the web. +The comment area supports [Markdown] and [quick actions]. You can edit your own +comment at any time, and anyone with [Maintainer access level][permissions] or +higher can also edit a comment made by someone else. -Apart from the standard comments, you also have the option to create a comment -in the form of a resolvable or threaded discussion. +You can also reply to a comment notification email to reply to the comment if +[Reply by email] is configured for your GitLab instance. Replying to a standard comment +creates another standard comment. Replying to a discussion comment creates a reply in the +discussion thread. Email replies support [Markdown] and [quick actions], just as if you replied from the web. -## Resolvable discussions +## Resolvable comments and discussions > **Notes:** > - The main feature was [introduced][ce-5022] in GitLab 8.11. > - Resolvable discussions can be added only to merge request diffs. Discussion resolution helps keep track of progress during planning or code review. -Resolving comments prevents you from forgetting to address feedback and lets you -hide discussions that are no longer relevant. -!["A discussion between two people on a piece of code"][discussion-view] +Every standard comment or discussion thread in merge requests, commits, commit diffs, and +snippets is initially displayed as unresolved. They can then be individually resolved by anyone +with at least Developer access to the project or by the author of the change being reviewed. -Comments and discussions can be resolved by anyone with at least Developer -access to the project or the author of the merge request. +The need to resolve all standard comments or discussions prevents you from forgetting +to address feedback and lets you hide discussions that are no longer relevant. + +!["A discussion between two people on a piece of code"][discussion-view] ### Commit discussions in the context of a merge request @@ -340,15 +343,15 @@ and push the suggested change directly into the codebase in the merge request's Custom commit messages will be introduced by [#54404](https://gitlab.com/gitlab-org/gitlab-ce/issues/54404). -## Start a discussion by replying to a non-discussion comment +## Start a discussion by replying to a standard comment > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/30299) in GitLab 11.9 -To reply a non-discussion comment, you can use the **Reply to comment** button. +To reply to a standard (non-discussion) comment, you can use the **Reply to comment** button. ![Reply to comment button](img/reply_to_comment_button.png) -The **Reply to comment** button is only displayed if you have permissions to reply to an existing discussion, or start a discussion from a standalone comment. +The **Reply to comment** button is only displayed if you have permissions to reply to an existing discussion, or start a discussion from a standard comment. Clicking on the **Reply to comment** button will bring the reply area into focus and you can type your reply. |