summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2017-09-07 18:03:14 +0000
committerSimon Knox <psimyn@gmail.com>2017-09-08 22:58:52 +1000
commit779121843740eee13cd69c4a31b7e8ee51670772 (patch)
tree47f95f8d9269e9225dd2120994cb54b6ed068de0
parent92f4484a403103ca4977d1a56588f728ac4f09a2 (diff)
downloadgitlab-ce-779121843740eee13cd69c4a31b7e8ee51670772.tar.gz
Merge branch 'docs-confidential-issue' into 'master'
Update docs for confidential issues Closes #36352 See merge request !14117
-rw-r--r--changelogs/unreleased/docs-confidential-issue.yml5
-rw-r--r--doc/user/project/issues/confidential_issues.md24
-rw-r--r--[-rwxr-xr-x]doc/user/project/issues/img/confidential_issues_index_page.pngbin8349 -> 107117 bytes
-rw-r--r--[-rwxr-xr-x]doc/user/project/issues/img/confidential_issues_issue_page.pngbin14230 -> 25354 bytes
-rwxr-xr-xdoc/user/project/issues/img/sidebar_confidential_issue.pngbin0 -> 10210 bytes
-rwxr-xr-xdoc/user/project/issues/img/sidebar_not_confidential_issue.pngbin0 -> 8163 bytes
-rw-r--r--doc/user/project/issues/img/turn_off_confidentiality.pngbin0 -> 27307 bytes
-rw-r--r--doc/user/project/issues/img/turn_on_confidentiality.pngbin0 -> 33499 bytes
8 files changed, 24 insertions, 5 deletions
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
index e4b492a2769..f3efe0ce04e 100755..100644
--- a/doc/user/project/issues/img/confidential_issues_index_page.png
+++ b/doc/user/project/issues/img/confidential_issues_index_page.png
Binary files 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
index f04ec8ff32b..0f5c774d258 100755..100644
--- a/doc/user/project/issues/img/confidential_issues_issue_page.png
+++ b/doc/user/project/issues/img/confidential_issues_issue_page.png
Binary files 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
--- /dev/null
+++ b/doc/user/project/issues/img/sidebar_confidential_issue.png
Binary files 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
--- /dev/null
+++ b/doc/user/project/issues/img/sidebar_not_confidential_issue.png
Binary files 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
--- /dev/null
+++ b/doc/user/project/issues/img/turn_off_confidentiality.png
Binary files 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
--- /dev/null
+++ b/doc/user/project/issues/img/turn_on_confidentiality.png
Binary files differ