Merge branch 'resolvable-discussions-docs' into 'master'
discussions docs See merge request !10390
Achilleas Pipinellis
|
|
@ -15,6 +15,7 @@ All technical content published by GitLab lives in the documentation, including:
|
|||
- [API](api/README.md) Automate GitLab via a simple and powerful API.
|
||||
- [CI/CD](ci/README.md) GitLab Continuous Integration (CI) and Continuous Delivery (CD) getting started, `.gitlab-ci.yml` options, and examples.
|
||||
- [Container Registry](user/project/container_registry.md) Learn how to use GitLab Container Registry.
|
||||
- [Discussions](user/discussions/index.md) Threads, comments, and resolvable discussions in issues, commits, and merge requests.
|
||||
- [Git Attributes](user/project/git_attributes.md) Managing Git attributes using a `.gitattributes` file.
|
||||
- [Git cheatsheet](https://gitlab.com/gitlab-com/marketing/raw/master/design/print/git-cheatsheet/print-pdf/git-cheatsheet.pdf) Download a PDF describing the most used Git operations.
|
||||
- [GitLab as OAuth2 authentication service provider](integration/oauth_provider.md). It allows you to login to other applications from GitLab.
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
BIN
doc/user/discussions/img/comment_type_toggle.gif
Normal file
|
After Width: | Height: | Size: 69 KiB |
BIN
doc/user/discussions/img/discussion_comment.png
Normal file
|
After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 4.1 KiB After Width: | Height: | Size: 4.1 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
|
Before Width: | Height: | Size: 140 KiB After Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 4.6 KiB After Width: | Height: | Size: 4.6 KiB |
|
Before Width: | Height: | Size: 4.6 KiB After Width: | Height: | Size: 4.6 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
150
doc/user/discussions/index.md
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
# Discussions
|
||||
|
||||
The ability to contribute conversationally is offered throughout GitLab.
|
||||
|
||||
You can leave a comment in the following places:
|
||||
|
||||
- issues
|
||||
- merge requests
|
||||
- snippets
|
||||
- commits
|
||||
- commit diffs
|
||||
|
||||
The comment area supports [Markdown] and [slash commands]. One can edit their
|
||||
own comment at any time, and anyone with [Master access level][permissions] or
|
||||
higher can also 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.
|
||||
|
||||
## Resolvable 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]
|
||||
|
||||
Comments and discussions can be resolved by anyone with at least Developer
|
||||
access to the project or the author of the merge request.
|
||||
|
||||
### Jumping between unresolved discussions
|
||||
|
||||
When a merge request has a large number of comments it can be difficult to track
|
||||
what remains unresolved. You can jump between unresolved discussions with the
|
||||
Jump button next to the Reply field on a discussion.
|
||||
|
||||
You can also jump to the first unresolved discussion from the button next to the
|
||||
resolved discussions tracker.
|
||||
|
||||
!["3/4 discussions resolved"][discussions-resolved]
|
||||
|
||||
### Marking a comment or discussion as resolved
|
||||
|
||||
You can mark a discussion as resolved by clicking the **Resolve discussion**
|
||||
button at the bottom of the discussion.
|
||||
|
||||
!["Resolve discussion" button][resolve-discussion-button]
|
||||
|
||||
Alternatively, you can mark each comment as resolved individually.
|
||||
|
||||
!["Resolve comment" button][resolve-comment-button]
|
||||
|
||||
### Move all unresolved discussions in a merge request to an issue
|
||||
|
||||
> [Introduced][ce-8266] in GitLab 9.1
|
||||
|
||||
To continue all open discussions from a merge request in a new issue, click the
|
||||
**Resolve all discussions in new issue** button.
|
||||
|
||||
|
||||
|
||||
Alternatively, when your project only accepts merge requests [when all discussions
|
||||
are resolved](#only-allow-merge-requests-to-be-merged-if-all-discussions-are-resolved),
|
||||
there will be an **open an issue to resolve them later** link in the merge
|
||||
request widget.
|
||||
|
||||
|
||||
|
||||
This will prepare an issue with its content referring to the merge request and
|
||||
the unresolved discussions.
|
||||
|
||||
|
||||
|
||||
Hitting **Submit issue** will cause all discussions to be marked as resolved and
|
||||
add a note referring to the newly created issue.
|
||||
|
||||
|
||||
|
||||
You can now proceed to merge the merge request from the UI.
|
||||
|
||||
### Moving a single discussion to a new issue
|
||||
|
||||
> [Introduced][ce-8266] in GitLab 9.1
|
||||
|
||||
To create a new issue for a single discussion, you can use the **Resolve this
|
||||
discussion in a new issue** button.
|
||||
|
||||
|
||||
|
||||
This will direct you to a new issue prefilled with the content of the
|
||||
discussion, similar to the issues created for delegating multiple
|
||||
discussions at once. Saving the issue will mark the discussion as resolved and
|
||||
add a note to the merge request discussion referencing the new issue.
|
||||
|
||||
|
||||
|
||||
### Only allow merge requests to be merged if all discussions are resolved
|
||||
|
||||
> [Introduced][ce-7125] in GitLab 8.14.
|
||||
|
||||
You can prevent merge requests from being merged until all discussions are
|
||||
resolved.
|
||||
|
||||
Navigate to your project's settings page, select the
|
||||
**Only allow merge requests to be merged if all discussions are resolved** check
|
||||
box and hit **Save** for the changes to take effect.
|
||||
|
||||
|
||||
|
||||
From now on, you will not be able to merge from the UI until all discussions
|
||||
are resolved.
|
||||
|
||||
|
||||
|
||||
## Threaded discussions
|
||||
|
||||
> [Introduced][ce-7527] in GitLab 9.1.
|
||||
|
||||
While resolvable discussions are only available to merge request diffs,
|
||||
discussions can also be added without a diff. You can start a specific
|
||||
discussion which will look like a thread, on issues, commits, snippets, and
|
||||
merge requests.
|
||||
|
||||
To start a threaded discussion, click on the **Comment** button toggle dropdown,
|
||||
select **Start discussion** and click **Start discussion** when you're ready to
|
||||
post the comment.
|
||||
|
||||
|
||||
|
||||
This will post a comment with a single thread to allow you to discuss specific
|
||||
comments in greater detail.
|
||||
|
||||
|
||||
|
||||
[ce-5022]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5022
|
||||
[ce-7125]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7125
|
||||
[ce-7527]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7527
|
||||
[ce-7180]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7180
|
||||
[ce-8266]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8266
|
||||
[resolve-discussion-button]: img/resolve_discussion_button.png
|
||||
[resolve-comment-button]: img/resolve_comment_button.png
|
||||
[discussion-view]: img/discussion_view.png
|
||||
[discussions-resolved]: img/discussions_resolved.png
|
||||
[markdown]: ../markdown.md
|
||||
[slash commands]: ../project/slash_commands.md
|
||||
[permissions]: ../permissions.md
|
||||
|
|
@ -34,7 +34,7 @@ Keep track of the progress during a code review with resolving comments.
|
|||
Resolving comments prevents you from forgetting to address feedback and lets
|
||||
you hide discussions that are no longer relevant.
|
||||
|
||||
[Read more about resolving discussion comments in merge requests reviews.](merge_request_discussion_resolution.md)
|
||||
[Read more about resolving discussion comments in merge requests reviews.](../../discussions/index.md)
|
||||
|
||||
## Resolve conflicts
|
||||
|
||||
|
|
|
|||
|
|
@ -1,106 +1 @@
|
|||
# Merge Request discussion resolution
|
||||
|
||||
> [Introduced][ce-5022] in GitLab 8.11.
|
||||
|
||||
Discussion resolution helps keep track of progress during 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]
|
||||
|
||||
Comments and discussions can be resolved by anyone with at least Developer
|
||||
access to the project, as well as by the author of the merge request.
|
||||
|
||||
## Marking a comment or discussion as resolved
|
||||
|
||||
You can mark a discussion as resolved by clicking the "Resolve discussion"
|
||||
button at the bottom of the discussion.
|
||||
|
||||
!["Resolve discussion" button][resolve-discussion-button]
|
||||
|
||||
Alternatively, you can mark each comment as resolved individually.
|
||||
|
||||
!["Resolve comment" button][resolve-comment-button]
|
||||
|
||||
## Jumping between unresolved discussions
|
||||
|
||||
When a merge request has a large number of comments it can be difficult to track
|
||||
what remains unresolved. You can jump between unresolved discussions with the
|
||||
Jump button next to the Reply field on a discussion.
|
||||
|
||||
You can also jump to the first unresolved discussion from the button next to the
|
||||
resolved discussions tracker.
|
||||
|
||||
!["3/4 discussions resolved"][discussions-resolved]
|
||||
|
||||
## Only allow merge requests to be merged if all discussions are resolved
|
||||
|
||||
> [Introduced][ce-7125] in GitLab 8.14.
|
||||
|
||||
You can prevent merge requests from being merged until all discussions are
|
||||
resolved.
|
||||
|
||||
Navigate to your project's settings page, select the
|
||||
**Only allow merge requests to be merged if all discussions are resolved** check
|
||||
box and hit **Save** for the changes to take effect.
|
||||
|
||||
|
||||
|
||||
From now on, you will not be able to merge from the UI until all discussions
|
||||
are resolved.
|
||||
|
||||
|
||||
|
||||
## Move all unresolved discussions in a merge request to an issue
|
||||
|
||||
> [Introduced][ce-8266]
|
||||
|
||||
To continue all open discussions in a merge request, click the button **Resolve
|
||||
all discussions in new issue**
|
||||
|
||||
|
||||
|
||||
Alternatively, when your project only accepts merge requests when all discussions
|
||||
are resolved, there will be an **open an issue to resolve them later** link in
|
||||
the merge request-widget.
|
||||
|
||||
|
||||
|
||||
This will prepare an issue with content referring to the merge request and
|
||||
discussions.
|
||||
|
||||
|
||||
|
||||
Hitting **Submit issue** will cause all discussions to be marked as resolved and
|
||||
add a note referring to the newly created issue.
|
||||
|
||||
|
||||
|
||||
You can now proceed to merge the merge request from the UI.
|
||||
|
||||
## Moving a single discussion to a new issue
|
||||
|
||||
> [Introduced][ce-8266]
|
||||
|
||||
To create a new issue for a single discussion, you can use the **Resolve this
|
||||
discussion in a new issue** button.
|
||||
|
||||
|
||||
|
||||
This will direct you to a new issue prefilled with the content of the
|
||||
discussion, similar to the issues created for delegating multiple
|
||||
discussions at once.
|
||||
|
||||
|
||||
|
||||
Saving the issue will mark the discussion as resolved and add a note
|
||||
to the discussion referencing the new issue.
|
||||
|
||||
[ce-5022]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5022
|
||||
[ce-7125]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7125
|
||||
[ce-7180]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7180
|
||||
[ce-8266]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8266
|
||||
[resolve-discussion-button]: img/resolve_discussion_button.png
|
||||
[resolve-comment-button]: img/resolve_comment_button.png
|
||||
[discussion-view]: img/discussion_view.png
|
||||
[discussions-resolved]: img/discussions_resolved.png
|
||||
This document was moved to [another location](../../discussions/index.md).
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
- [Authorization for merge requests](../user/project/merge_requests/authorization_for_merge_requests.md)
|
||||
- [Cherry-pick changes](../user/project/merge_requests/cherry_pick_changes.md)
|
||||
- [Merge when pipeline succeeds](../user/project/merge_requests/merge_when_pipeline_succeeds.md)
|
||||
- [Resolve discussion comments in merge requests reviews](../user/project/merge_requests/merge_request_discussion_resolution.md)
|
||||
- [Resolve discussion comments in merge requests reviews](../user/discussions/index.md)
|
||||
- [Resolve merge conflicts in the UI](../user/project/merge_requests/resolve_conflicts.md)
|
||||
- [Revert changes in the UI](../user/project/merge_requests/revert_changes.md)
|
||||
- [Merge requests versions](../user/project/merge_requests/versions.md)
|
||||
|
|
|
|||