Merge branch 'docs-confidential-issue' into 'master'
Update docs for confidential issues Closes #36352 See merge request !14117
5
changelogs/unreleased/docs-confidential-issue.yml
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Update documentation for confidential issue
|
||||
merge_request: 14117
|
||||
author:
|
||||
type: other
|
|
@ -9,7 +9,7 @@ keep security vulnerabilities private or prevent surprises from leaking out.
|
|||
|
||||
## Making an issue confidential
|
||||
|
||||
You can make an issue confidential either by creating a new issue or editing
|
||||
You can make an issue confidential during issue creation or by editing
|
||||
an existing one.
|
||||
|
||||
When you create a new issue, a checkbox right below the text area is available
|
||||
|
@ -19,11 +19,19 @@ confidential checkbox and hit **Save changes**.
|
|||
|
||||
![Creating a new confidential issue](img/confidential_issues_create.png)
|
||||
|
||||
## Making an issue non-confidential
|
||||
## Modifying issue confidentiality
|
||||
|
||||
To make an issue non-confidential, all you have to do is edit it and unmark
|
||||
the confidential checkbox. Once you save the issue, it will gain the default
|
||||
visibility level you have chosen for your project.
|
||||
There are two ways to change an issue's confidentiality.
|
||||
|
||||
The first way is to edit the issue and mark/unmark the confidential checkbox.
|
||||
Once you save the issue, it will change the confidentiality of the issue.
|
||||
|
||||
The second way is to locate the Confidentiality section in the sidebar and click
|
||||
**Edit**. A popup should appear and give you the option to turn on or turn off confidentiality.
|
||||
|
||||
| Turn off confidentiality | Turn on confidentiality |
|
||||
| :-----------: | :----------: |
|
||||
| ![Turn off confidentiality](img/turn_off_confidentiality.png) | ![Turn on confidentiality](img/turn_on_confidentiality.png) |
|
||||
|
||||
Every change from regular to confidential and vice versa, is indicated by a
|
||||
system note in the issue's comments.
|
||||
|
@ -49,6 +57,12 @@ issue you are commenting on is confidential.
|
|||
|
||||
![Confidential issue page](img/confidential_issues_issue_page.png)
|
||||
|
||||
There is also an indicator on the sidebar denoting confidentiality.
|
||||
|
||||
| Confidential issue | Not confidential issue |
|
||||
| :-----------: | :----------: |
|
||||
| ![Sidebar confidential issue](img/sidebar_confidential_issue.png) | ![Sidebar not confidential issue](img/sidebar_not_confidential_issue.png) |
|
||||
|
||||
## Permissions and access to confidential issues
|
||||
|
||||
There are two kinds of level access for confidential issues. The general rule
|
||||
|
|
BIN
doc/user/project/issues/img/confidential_issues_index_page.png
Executable file → Normal file
Before Width: | Height: | Size: 8.2 KiB After Width: | Height: | Size: 105 KiB |
BIN
doc/user/project/issues/img/confidential_issues_issue_page.png
Executable file → Normal file
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 25 KiB |
BIN
doc/user/project/issues/img/sidebar_confidential_issue.png
Executable file
After Width: | Height: | Size: 10 KiB |
BIN
doc/user/project/issues/img/sidebar_not_confidential_issue.png
Executable file
After Width: | Height: | Size: 8 KiB |
BIN
doc/user/project/issues/img/turn_off_confidentiality.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
doc/user/project/issues/img/turn_on_confidentiality.png
Normal file
After Width: | Height: | Size: 33 KiB |