Merge branch 'docs-image-discussion' into 'master'
Add image discussion docs Closes #38879 See merge request gitlab-org/gitlab-ce!14743
This commit is contained in:
commit
a30417e5c5
6 changed files with 40 additions and 3 deletions
BIN
doc/user/discussions/img/image_resolved_discussion.png
Executable file
BIN
doc/user/discussions/img/image_resolved_discussion.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 47 KiB |
BIN
doc/user/discussions/img/onion_skin_view.png
Executable file
BIN
doc/user/discussions/img/onion_skin_view.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 44 KiB |
BIN
doc/user/discussions/img/start_image_discussion.gif
Normal file
BIN
doc/user/discussions/img/start_image_discussion.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 143 KiB |
BIN
doc/user/discussions/img/swipe_view.png
Executable file
BIN
doc/user/discussions/img/swipe_view.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
BIN
doc/user/discussions/img/two_up_view.png
Executable file
BIN
doc/user/discussions/img/two_up_view.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 60 KiB |
|
@ -153,6 +153,43 @@ comments in greater detail.
|
|||
|
||||
![Discussion comment](img/discussion_comment.png)
|
||||
|
||||
## Image discussions
|
||||
|
||||
> [Introduced][ce-14531] in GitLab 10.1.
|
||||
|
||||
Sometimes a discussion is revolved around an image. With image discussions,
|
||||
you can easily target a specific coordinate of an image and start a discussion
|
||||
around it. Image discussions are available in merge requests and commit detail views.
|
||||
|
||||
To start an image discussion, hover your mouse over the image. Your mouse pointer
|
||||
should convert into an icon, indicating that the image is available for commenting.
|
||||
Simply click anywhere on the image to create a new discussion.
|
||||
|
||||
![Start image discussion](img/start_image_discussion.gif)
|
||||
|
||||
After you click on the image, a comment form will be displayed that would be the start
|
||||
of your discussion. Once you save your comment, you will see a new badge displayed on
|
||||
top of your image. This badge represents your discussion.
|
||||
|
||||
>**Note:**
|
||||
This discussion badge is typically associated with a number that is only used as a visual
|
||||
reference for each discussion. In the merge request discussion tab,
|
||||
this badge will be indicated with a comment icon since each discussion will render a new
|
||||
image section.
|
||||
|
||||
Image discussions also work on diffs that replace an existing image. In this diff view
|
||||
mode, you can toggle the different view modes and still see the discussion point badges.
|
||||
|
||||
| 2-up | Swipe | Onion Skin |
|
||||
| :-----------: | :----------: | :----------: |
|
||||
| ![2-up view](img/two_up_view.png) | ![swipe view](img/swipe_view.png) | ![onion skin view](img/onion_skin_view.png) |
|
||||
|
||||
Image discussions also work well with resolvable discussions. Resolved discussions
|
||||
on diffs (not on the merge request discussion tab) will appear collapsed on page
|
||||
load and will have a corresponding badge counter to match the counter on the image.
|
||||
|
||||
![Image resolved discussion](img/image_resolved_discussion.png)
|
||||
|
||||
## Lock discussions
|
||||
|
||||
> [Introduced][ce-14531] in GitLab 10.1.
|
||||
|
@ -163,8 +200,8 @@ in issues or merge requests in these scenarios:
|
|||
- The project maintainer has already resolved the discussion and it is not helpful
|
||||
for continued feedback. The project maintainer has already directed new conversation
|
||||
to newer issues or merge requests.
|
||||
- The people participating in the discussion are trolling, abusive, or otherwise
|
||||
being unproductive.
|
||||
- The people participating in the discussion are trolling, abusive, or otherwise
|
||||
being unproductive.
|
||||
|
||||
In these cases, a user with Master permissions or higher in the project can lock (and unlock)
|
||||
an issue or a merge request, using the "Lock" section in the sidebar:
|
||||
|
@ -177,7 +214,7 @@ System notes indicate locking and unlocking.
|
|||
|
||||
![Discussion lock system notes](img/discussion_lock_system_notes.png)
|
||||
|
||||
In a locked issue or merge request, only team members can add new comments and
|
||||
In a locked issue or merge request, only team members can add new comments and
|
||||
edit existing comments. Non-team members are restricted from adding or editing comments.
|
||||
|
||||
| Team member | Non-team member |
|
||||
|
|
Loading…
Reference in a new issue