diff --git a/changelogs/unreleased/docs-confidential-issue.yml b/changelogs/unreleased/docs-confidential-issue.yml new file mode 100644 index 00000000000..841970ef4cf --- /dev/null +++ b/changelogs/unreleased/docs-confidential-issue.yml @@ -0,0 +1,5 @@ +--- +title: Update documentation for confidential issue +merge_request: 14117 +author: +type: other diff --git a/doc/user/project/issues/confidential_issues.md b/doc/user/project/issues/confidential_issues.md index 1760b182114..0bf1f396f9d 100644 --- a/doc/user/project/issues/confidential_issues.md +++ b/doc/user/project/issues/confidential_issues.md @@ -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 diff --git a/doc/user/project/issues/img/confidential_issues_index_page.png b/doc/user/project/issues/img/confidential_issues_index_page.png old mode 100755 new mode 100644 index e4b492a2769..f3efe0ce04e Binary files a/doc/user/project/issues/img/confidential_issues_index_page.png and b/doc/user/project/issues/img/confidential_issues_index_page.png differ diff --git a/doc/user/project/issues/img/confidential_issues_issue_page.png b/doc/user/project/issues/img/confidential_issues_issue_page.png old mode 100755 new mode 100644 index f04ec8ff32b..0f5c774d258 Binary files a/doc/user/project/issues/img/confidential_issues_issue_page.png and b/doc/user/project/issues/img/confidential_issues_issue_page.png differ diff --git a/doc/user/project/issues/img/sidebar_confidential_issue.png b/doc/user/project/issues/img/sidebar_confidential_issue.png new file mode 100755 index 00000000000..d99a1ca756e Binary files /dev/null and b/doc/user/project/issues/img/sidebar_confidential_issue.png differ diff --git a/doc/user/project/issues/img/sidebar_not_confidential_issue.png b/doc/user/project/issues/img/sidebar_not_confidential_issue.png new file mode 100755 index 00000000000..2e6cbbc5b3a Binary files /dev/null and b/doc/user/project/issues/img/sidebar_not_confidential_issue.png differ diff --git a/doc/user/project/issues/img/turn_off_confidentiality.png b/doc/user/project/issues/img/turn_off_confidentiality.png new file mode 100644 index 00000000000..248ae6522d6 Binary files /dev/null and b/doc/user/project/issues/img/turn_off_confidentiality.png differ diff --git a/doc/user/project/issues/img/turn_on_confidentiality.png b/doc/user/project/issues/img/turn_on_confidentiality.png new file mode 100644 index 00000000000..fac4c833699 Binary files /dev/null and b/doc/user/project/issues/img/turn_on_confidentiality.png differ