Commit 67e9e9ab authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski

Merge branch 'eread/refine-linked-issues' into 'master'

Refine linked issues content

See merge request gitlab-org/gitlab!57948
parents c294612d 2a789425
......@@ -4,42 +4,34 @@ group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
# Related issues **(FREE)**
# Linked issues **(FREE)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1797) in GitLab 9.4.
> - The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.4.
Related issues are a bi-directional relationship between any two issues
and appear in a block below the issue description. Issues can be across groups
and projects.
Linked issues are a bi-directional relationship between any two issues and appear in a block below
the issue description. Issues can be across groups and projects.
You can set any issue as:
- Related to another issue
- Blocking another issue **(PREMIUM)**
- Blocked by another issue **(PREMIUM)**
The relationship only shows up in the UI if the user can see both issues.
When you try to close an issue that has open blockers, a warning is displayed.
The relationship only shows up in the UI if the user can see both issues. When you try to close an
issue that has open blockers, a warning is displayed.
NOTE:
To manage related issues through our API, visit the [issue links API documentation](../../../api/issue_links.md).
To manage linked issues through our API, visit the [issue links API documentation](../../../api/issue_links.md).
## Adding a related issue
## Add a linked issue
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2035) in GitLab 12.8.
> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/34239) to warn when attempting to close an issue that is blocked by others in GitLab 13.0.
> When you try to close an issue with open blockers, you see a warning that you can dismiss.
1. Relate one issue to another by clicking the related issues "+" button
in the header of the related issue block.
1. Link one issue to another by selecting the add linked issue button (**{plus}**) in the
**Linked issues** section of an issue.
1. Select the relationship the between the two issues. Either:
- **relates to**.
- **blocks**. **(PREMIUM)**
- **is blocked by**. **(PREMIUM)**
1. Input the issue reference number or paste in the full URL of the issue.
- **relates to**
- **blocks** **(PREMIUM)**
- **is blocked by** **(PREMIUM)**
1. Input the issue number or paste in the full URL of the issue.
![Adding a related issue](img/related_issues_add_v12_8.png)
......@@ -53,20 +45,20 @@ in the header of the related issue block.
Valid references are added to a temporary list that you can review.
1. When you have added all the related issues, click **Add** to submit.
1. When you have added all the linked issues, select **Add**.
When you have finished adding all related issues, you can see
When you have finished adding all linked issues, you can see
them categorized so their relationships can be better understood visually.
![Related issue block](img/related_issue_block_v12_8.png)
## Removing a related issue
## Remove a linked issue
In the related issues block, click the remove button (**{close}**) on the right-side of each issue
token that you wish to remove.
In the **Linked issues** section of an issue, click the remove button (**{close}**) on the
right-side of each issue token to remove.
Due to the bi-directional relationship, it no longer appears in either issue.
Due to the bi-directional relationship, the relationship no longer appears in either issue.
![Removing a related issue](img/related_issues_remove_v12_8.png)
Please access our [permissions](../../permissions.md) page for more information.
Access our [permissions](../../permissions.md) page for more information.
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