diff options
Diffstat (limited to 'doc/user/discussions/index.md')
-rw-r--r-- | doc/user/discussions/index.md | 125 |
1 files changed, 21 insertions, 104 deletions
diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index 096b4dc2cc5..03b48fd42b6 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -18,7 +18,7 @@ GitLab encourages communication through comments, threads, and Two types of comments are available: - A standard comment. -- A comment in a thread, which can be [resolved](#resolve-a-thread). +- A comment in a thread, which can be [resolved](../project/merge_requests/index.md#resolve-a-thread). In a comment, you can enter [Markdown](../markdown.md) and use [quick actions](../project/quick_actions.md). @@ -51,9 +51,25 @@ You can quickly see which comments involve you, because mentions for yourself (the user who is signed in) are highlighted in a different color. -Avoid mentioning `@all` in issues and merge requests. It sends an email notification -to all members of that project's parent group, not only the participants of the project. -It might be interpreted as spam. +### Mentioning all members + +> [Flag](../../administration/feature_flags.md) named `disable_all_mention` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110586) in GitLab 16.1. Disabled by default. [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/18442). + +FLAG: +On self-managed GitLab, by default this flag is not enabled. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) +named `disable_all_mention`. +On GitLab.com, this flag is enabled. + +When this feature flag is enabled, typing `@all` in comments and descriptions +results in plain text instead of a mention. +When you disable this feature, existing `@all` mentions in the Markdown texts are not affected +and remain as links. Only future `@all` mentions appear as plain text. + +Avoid mentioning `@all` in comments and descriptions. +When you do it, you don't only mention the participants of the project, issue, or merge request, +but to all members of that project's parent group. +All these users receive an email notification and a to-do item. It might be interpreted as spam. + Notifications and mentions can be disabled in [a group's settings](../group/manage.md#disable-email-notifications). @@ -95,29 +111,6 @@ it's converted to a link in the context of the merge request. For example, `28719b171a056960dfdc0012b625d0b47b123196` becomes `28719b17` that links to `https://gitlab.example.com/example-group/example-project/-/merge_requests/12345/diffs?commit_id=28719b171a056960dfdc0012b625d0b47b123196`. -## Add a comment to a commit - -You can add comments and threads to a particular commit. - -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Repository > Commits**. -1. Below the commits, in the **Comment** field, enter a comment. -1. Select **Comment** or select the down arrow (**{chevron-down}**) to select **Start thread**. - -WARNING: -Threads created this way are lost if the commit ID changes after a -force push. - -## Add a comment to an image - -In merge requests and commit detail views, you can add a comment to an image. -This comment can also be a thread. - -1. Hover your mouse over the image. -1. Select the location where you want to comment. - -An icon is displayed on the image and a comment field is displayed. - ## Reply to a comment by sending email If you have ["reply by email"](../../administration/reply_by_email.md) configured, @@ -236,8 +229,6 @@ To compare the changes, select **Compare with previous version**. ## Assign an issue to the commenting user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/191455) in GitLab 13.1. - You can assign an issue to a user who made a comment. 1. In the comment, select the **More Actions** (**{ellipsis_v}**) menu. @@ -256,9 +247,7 @@ Prerequisites: To create a thread by replying to a comment: -1. In the upper-right corner of the comment, select **Reply to comment** (**{comment}**). - - ![Reply to comment button](img/reply_to_comment_button.png) +1. In the upper-right corner of the comment, select **Reply to comment** (**{reply}**). The reply section is displayed. @@ -286,75 +275,3 @@ To create a thread: A threaded comment is created. ![Thread comment](img/discussion_comment.png) - -## Resolve a thread - -> Resolving comments individually was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/28750) in GitLab 13.6. - -In a merge request, you can resolve a thread when you want to finish a conversation. - -Prerequisites: - -- You must have at least the Developer role - or be the author of the change being reviewed. -- Resolvable threads can be added only to merge requests. It doesn't work - for comments in issues, commits, or snippets. - -To resolve a thread: - -1. Go to the thread. -1. Do one of the following: - - In the upper-right corner of the original comment, select **Resolve thread** (**{check-circle}**). - - Below the last reply, in the **Reply** field, select **Resolve thread**. - - Below the last reply, in the **Reply** field, enter text, select the **Resolve thread** checkbox, and select **Add comment now**. - -At the top of the page, the number of unresolved threads is updated: - -![Count of unresolved threads](img/unresolved_threads_v15_4.png) - -### Move all unresolved threads in a merge request to an issue - -If you have multiple unresolved threads in a merge request, you can -create an issue to resolve them separately. In the merge request, at the top of the page, -select the ellipsis icon button (**{ellipsis_v}**) in the threads control and then select **Resolve all with new issue**: - -![Open new issue for all unresolved threads](img/create_new_issue_v15_4.png) - -All threads are marked as resolved, and a link is added from the merge request to -the newly created issue. - -### Move one unresolved thread in a merge request to an issue - -If you have one specific unresolved thread in a merge request, you can -create an issue to resolve it separately. In the merge request, under the last reply -to the thread, next to **Resolve thread**, select **Create issue to resolve thread** (**{issue-new}**): - -![Create issue for thread](img/new-issue-one-thread_v14_3.png) - -The thread is marked as resolved, and a link is added from the merge request to -the newly created issue. - -### Prevent merge unless all threads are resolved - -You can prevent merge requests from being merged until all threads are -resolved. When this setting is enabled, the **Unresolved threads** counter in a merge request -is shown in orange when at least one thread remains unresolved. - -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Merge requests**. -1. In the **Merge checks** section, select the **All threads must be resolved** checkbox. -1. Select **Save changes**. - -### Automatically resolve threads in a merge request when they become outdated - -You can set merge requests to automatically resolve threads when lines are modified -with a new push. - -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Merge requests**. -1. In the **Merge options** section, select - **Automatically resolve merge request diff threads when they become outdated**. -1. Select **Save changes**. - -Threads are now resolved if a push makes a diff section outdated. -Threads on lines that don't change and top-level resolvable threads are not resolved. |