From 4923c7a5dba164ea8139a14cc4b09d98686ca4ea Mon Sep 17 00:00:00 2001 From: Amanda Rueda <2890431-amandarueda@users.noreply.gitlab.com> Date: Thu, 3 Oct 2024 09:26:40 +0000 Subject: [PATCH] Updating linked epic docs based on new features --- doc/user/group/epics/linked_epics.md | 86 ++++++++++++++++++++++++++-- 1 file changed, 80 insertions(+), 6 deletions(-) diff --git a/doc/user/group/epics/linked_epics.md b/doc/user/group/epics/linked_epics.md index eefb2db870921..beffcea85fb1e 100644 --- a/doc/user/group/epics/linked_epics.md +++ b/doc/user/group/epics/linked_epics.md @@ -13,10 +13,9 @@ DETAILS: Linked epics are a bi-directional relationship between any two epics and appear in a block below the epic description. You can link epics in different groups. -The relationship only shows up in the UI if the user can see both epics. When you try to close an -epic that has open blockers, a warning is displayed. +The relationship only shows up in the UI if the user can see both epics. +When you try to close an epic that has open blockers, a warning is displayed. -NOTE: To manage linked epics through our API, see [Linked epics API](../../../api/linked_epics.md). ## Add a linked epic @@ -34,9 +33,11 @@ To link one epic to another: 1. In the **Linked epics** section of an epic, select the add linked epic button (**{plus}**). 1. Select the relationship between the two epics. Either: + - **relates to** - **[blocks](#blocking-epics)** - **[is blocked by](#blocking-epics)** + 1. To enter the linked epic, either: - Enter `&`, followed by the epic's number. For example, `&123`. @@ -68,9 +69,9 @@ Prerequisites: - You must have at least the Guest role for the epic's group. -To remove a linked epic, in the **Linked epics** section of an epic, -select **Remove** (**{close}**) next to -each epic. +To remove a linked epic: + +- In the **Linked epics** section of an epic, next to each epic, select **Remove** (**{close}**). The relationship is removed from both epics. @@ -82,3 +83,76 @@ When you [add a linked epic](#add-a-linked-epic), you can show that it **blocks* **is blocked by** another epic. If you try to close a blocked epic using the "Close epic" button, a confirmation message appears. + +## When using the new look for epics + +> - Linking epics to issues, tasks, and OKRs [introduced](https://gitlab.com/groups/gitlab-org/-/epics/9290) in GitLab 17.5. Your administrator must have [enabled the new look for epics](epic_work_items.md). + +<!-- When epics as work items are GA, integrate this and below sections with the ones above. --> + +If your administrator [enabled the new look for epics](epic_work_items.md), you can also link epics +and the following items: + +- Issues +- Tasks +- Objectives +- Key results + +Linked items appear in the **Linked items** section, under the **Child items** section on the epic. +You can link epics to work items in different groups. + +The relationship only shows up in the UI if the user can see both items. +When you try to close an epic linked to an open blocker, a warning is displayed. + +To manage linked epics through our API, see the +[Work Items API](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/work_items/). + +### Add a linked item + +Prerequisites: + +- Your administrator must have [enabled the new look for epics](epic_work_items.md). +- You must have at least the Guest role for both groups or group and project. +- For GitLab SaaS: the epic that you're editing must be in a group on GitLab Ultimate. + The item you're linking can be in a group on a lower tier. + +To link an epic to another item: + +1. In the **Linked items** section of an epic, select **Add**. +1. Select the relationship between the two items. Either: + + - **relates to** + - **blocks** + - **is blocked by** + +1. To enter the linked item, either: + + - Enter `#`, followed by the item's number. For example, `#123`. + - Enter `#`, followed by a word from the item's title. For example, `#Deliver`. + - Paste in the item's full URL. + + Items of the same group can be specified just by the reference number. + Items from a different group require additional information like the + group name. For example: + + - The same group: `#44` + - Different group: `group#44` + + Valid references are added to a temporary list that you can review. + +1. Select **Add**. + +The linked items are then displayed on the epic grouped by relationship. + +### Remove a linked item + +Prerequisites: + +- Your administrator must have [enabled the new look for epics](epic_work_items.md). +- You must have at least the Guest role for the epic's group. + +To remove a linked item: + +- In the **Linked items** section of an epic, next to each item, select **Remove** (**{close}**). + +The relationship is removed from both items. -- GitLab