diff options
Diffstat (limited to 'doc/user/project/issues/confidential_issues.md')
-rw-r--r-- | doc/user/project/issues/confidential_issues.md | 62 |
1 files changed, 23 insertions, 39 deletions
diff --git a/doc/user/project/issues/confidential_issues.md b/doc/user/project/issues/confidential_issues.md index 6c2e6cb2132..0b8f6cc33fc 100644 --- a/doc/user/project/issues/confidential_issues.md +++ b/doc/user/project/issues/confidential_issues.md @@ -4,10 +4,10 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Confidential issues **(FREE)** +# Confidential issues **(FREE ALL)** Confidential issues are [issues](index.md) visible only to members of a project with -[sufficient permissions](#permissions-and-access-to-confidential-issues). +[sufficient permissions](#who-can-see-confidential-issues). Confidential issues can be used by open source projects and companies alike to keep security vulnerabilities private or prevent surprises from leaking out. @@ -15,6 +15,13 @@ keep security vulnerabilities private or prevent surprises from leaking out. You can make an issue confidential when you create or edit an issue. +Prerequisites: + +- You must have at least the Reporter role for the project. +- If the issue you want to make confidential has any child [tasks](../../tasks.md), + you must first make all the child tasks confidential. + A confidential issue can have only confidential children. + ### In a new issue When you create a new issue, a checkbox right below the text area is available @@ -51,63 +58,40 @@ for the project have access to the issue. Users with Guest or [Minimal](../../permissions.md#users-with-minimal-access) roles can't access the issue even if they were actively participating before the change. +However, a user with the **Guest role** can create confidential issues, but can only view the ones +that they created themselves. + +Users with the Guest role or non-members can read the confidential issue if they are assigned to the issue. +When a Guest user or non-member is unassigned from a confidential issue, they can no longer view it. + +Confidential issues are hidden in search results for users without the necessary permissions. + ## Confidential issue indicators Confidential issues are visually different from regular issues in a few ways. -In the issues index page view, you can see the confidential (**{eye-slash}**) icon -next to the issues that are marked as confidential: - -![Confidential issues index page](img/confidential_issues_index_page.png) +In the issues list and boards, you can see the confidential (**{eye-slash}**) icon +next to issues marked as confidential. -If you don't have [enough permissions](#permissions-and-access-to-confidential-issues), +If you don't have [enough permissions](#who-can-see-confidential-issues), you cannot see confidential issues at all. Likewise, while inside the issue, you can see the confidential (**{eye-slash}**) icon right next to the issue number. There is also an indicator in the comment area that the 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) | - Every change from regular to confidential and vice versa, is indicated by a -system note in the issue's comments: +system note in the issue's comments, for example: -- **{eye-slash}** The issue is made confidential. -- **{eye}** The issue is made public. - -![Confidential issues system notes](img/confidential_issues_system_notes_v15_4.png) +> - **{eye-slash}** Jo Garcia made the issue confidential 5 minutes ago +> - **{eye}** Jo Garcia made the issue visible to everyone just now ## Merge requests for confidential issues Although you can create confidential issues (and make existing issues confidential) in a public project, you cannot make confidential merge requests. Learn how to create [merge requests for confidential issues](../merge_requests/confidential.md) that prevent leaks of private data. -## Permissions and access to confidential issues - -Access to confidential issues is by one of two routes. The general rule -is that confidential issues are visible only to members of a project with at -least the **Reporter role**. - -However, a user with the **Guest role** can create -confidential issues, but can only view the ones that they created themselves. - -Users with the Guest role or non-members can read the confidential issue if they are assigned to the issue. -When a Guest user or non-member is unassigned from a confidential issue, -they can no longer view it. - -Confidential issues are hidden in search results for unprivileged users. -For example, here's what a user with the Maintainer role and the Guest role -sees in the project's search results: - -| Maintainer role | Guest role | -|:----------------|:-----------| -| ![Confidential issues search by maintainer](img/confidential_issues_search_master.png) | ![Confidential issues search by guest](img/confidential_issues_search_guest.png) | - ## Related topics - [Merge requests for confidential issues](../merge_requests/confidential.md) |