Commit ec1cfd76 authored by Jonston Chan's avatar Jonston Chan Committed by Amy Qualls

Docs: fix linting errors in doc/user/project/issues/confidential_issues.md

parent 0a234010
...@@ -29,8 +29,8 @@ confidential checkbox and hit **Save changes**. ...@@ -29,8 +29,8 @@ confidential checkbox and hit **Save changes**.
There are two ways to change an issue's confidentiality. There are two ways to change an issue's confidentiality.
The first way is to edit the issue and mark/unmark the confidential checkbox. The first way is to edit the issue and toggle the confidentiality checkbox.
Once you save the issue, it will change the confidentiality of the issue. After you save the issue, the confidentiality of the issue is updated.
The second way is to locate the Confidentiality section in the sidebar and click 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. **Edit**. A popup should appear and give you the option to turn on or turn off confidentiality.
...@@ -46,20 +46,19 @@ system note in the issue's comments. ...@@ -46,20 +46,19 @@ system note in the issue's comments.
## Indications of a confidential issue ## Indications of a confidential issue
NOTE:
If you don't have [enough permissions](#permissions-and-access-to-confidential-issues),
you won't be able to see the confidential issues at all.
There are a few things that visually separate a confidential issue from a There are a few things that visually separate a confidential issue from a
regular one. In the issues index page view, you can see the eye-slash icon regular one. In the issues index page view, you can see the eye-slash icon
next to the issues that are marked as confidential. next to the issues that are marked as confidential.
![Confidential issues index page](img/confidential_issues_index_page.png) ![Confidential issues index page](img/confidential_issues_index_page.png)
If you don't have [enough permissions](#permissions-and-access-to-confidential-issues),
you cannot see confidential issues at all.
--- ---
Likewise, while inside the issue, you can see the eye-slash icon right next to Likewise, while inside the issue, you can see the eye-slash icon right next to
the issue number, but there is also an indicator in the comment area that the the issue number. There is also an indicator in the comment area that the
issue you are commenting on is confidential. issue you are commenting on is confidential.
![Confidential issue page](img/confidential_issues_issue_page.png) ![Confidential issue page](img/confidential_issues_issue_page.png)
...@@ -83,7 +82,7 @@ project's search results respectively. ...@@ -83,7 +82,7 @@ project's search results respectively.
| Maintainer access | Guest access | | Maintainer access | Guest access |
| :-----------: | :----------: | | :-----------: | :----------: |
| ![Confidential issues search master](img/confidential_issues_search_master.png) | ![Confidential issues search guest](img/confidential_issues_search_guest.png) | | ![Confidential issues search by maintainer](img/confidential_issues_search_master.png) | ![Confidential issues search by guest](img/confidential_issues_search_guest.png) |
## Merge Requests for Confidential Issues ## Merge Requests for Confidential Issues
...@@ -93,24 +92,24 @@ To help prevent confidential information being leaked from a public project ...@@ -93,24 +92,24 @@ To help prevent confidential information being leaked from a public project
in the process of resolving a confidential issue, confidential issues can be in the process of resolving a confidential issue, confidential issues can be
resolved by creating a merge request from a private fork. resolved by creating a merge request from a private fork.
The merge request created will target the default branch of the private fork, The created merge request targets the default branch of the private fork,
not the default branch of the public upstream project. This prevents the merge not the default branch of the public upstream project. This prevents the merge
request, branch, and commits entering the public repository, and revealing request, branch, and commits entering the public repository, and revealing
confidential information prematurely. When the confidential commits are ready confidential information prematurely. To make a confidential commit public,
to be made public, this can be done by opening a merge request from the private open a merge request from the private fork to the public upstream project.
fork to the public upstream project.
NOTE: Permissions are inherited from parent groups. Developers have the same permissions
If you create a long-lived private fork in the same group or in a sub-group of for private forks created in the same group or in a sub-group of the original
the original upstream, all the users with Developer membership to the public Permissions are inherited from parent groups. When private forks are created
project will also have the same permissions in the private project. This way, in the same group or sub-group as the original upstream repository, users
all the Developers, who have access to view confidential issues, will have a receive the same permissions in both projects. This inheritance ensures
streamlined workflow for fixing them. Developer users have the needed permissions to both view confidential issues and
resolve them.
### How it works ### How it works
On a confidential issue, a **Create confidential merge request** button is On a confidential issue, a **Create confidential merge request** button is
available. Clicking on it will open a dropdown where you can choose to available. Clicking on it opens a dropdown where you can choose to
**Create confidential merge request and branch** or **Create branch**: **Create confidential merge request and branch** or **Create branch**:
| Create confidential merge request | Create branch | | Create confidential merge request | Create branch |
...@@ -121,12 +120,12 @@ The **Project** dropdown includes the list of private forks the user is a member ...@@ -121,12 +120,12 @@ The **Project** dropdown includes the list of private forks the user is a member
of as at least a Developer and merge requests are enabled. of as at least a Developer and merge requests are enabled.
Whenever the **Branch name** and **Source (branch or tag)** fields change, the Whenever the **Branch name** and **Source (branch or tag)** fields change, the
availability of the target or source branch will be checked. Both branches should availability of the target and source branch are checked. Both branches should
be available in the private fork selected. be available in the selected private fork.
By clicking the **Create confidential merge request** button, GitLab will create By clicking the **Create confidential merge request** button, GitLab creates
the branch and merge request in the private fork. When you choose the branch and merge request in the private fork. When you choose
**Create branch**, GitLab will only create the branch. **Create branch**, GitLab creates only the branch.
Once the branch is created in the private fork, developers can now push code to After the branch is created in the private fork, developers can push code to
that branch to fix the confidential issue. that branch to fix the confidential issue.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment