diff options
Diffstat (limited to 'doc/user/okrs.md')
| -rw-r--r-- | doc/user/okrs.md | 52 |
1 files changed, 44 insertions, 8 deletions
diff --git a/doc/user/okrs.md b/doc/user/okrs.md index 030f6eb82ef..2abaf9f8008 100644 --- a/doc/user/okrs.md +++ b/doc/user/okrs.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103355) in GitLab 15.6 [with a flag](../administration/feature_flags.md) named `okrs_mvc`. Disabled by default. -OKRs are an [Experiment](../policy/alpha-beta-support.md#experiment). +OKRs are an [Experiment](../policy/experiment-beta-support.md#experiment). For the OKR feature roadmap, see [epic 7864](https://gitlab.com/groups/gitlab-org/-/epics/7864). FLAG: @@ -60,8 +60,8 @@ Prerequisites: To create an objective: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. On the left sidebar, select **Plan > Issues**. 1. In the upper-right corner, next to **New issue**, select the down arrow **{chevron-lg-down}** and then select **New objective**. 1. Select **New objective** again. 1. Enter the objective title. @@ -77,8 +77,8 @@ Prerequisites: To view an objective: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. On the left sidebar, select **Plan > Issues**. 1. [Filter the list of issues](project/issues/managing_issues.md#filter-the-list-of-issues) for `Type = objective`. 1. Select the title of an objective from the list. @@ -91,8 +91,8 @@ Prerequisites: To view a key result: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. On the left sidebar, select **Plan > Issues**. 1. [Filter the list of issues](project/issues/managing_issues.md#filter-the-list-of-issues) for `Type = key_result`. 1. Select the title of a key result from the list. @@ -222,7 +222,8 @@ To set health status of an OKR: ## Promote a key result to an objective -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386877) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386877) in GitLab 16.0. +> - Quick action `/promote_to` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/412534) in GitLab 16.1. Prerequisites: @@ -234,6 +235,41 @@ To promote a key result: 1. In the top right corner, select the vertical ellipsis (**{ellipsis_v}**).. 1. Select **Promote to objective**. +Alternatively, use the `/promote_to objective` [quick action](../user/project/quick_actions.md). + +## Copy objective or key result reference + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. + +To refer to an objective or key result elsewhere in GitLab, you can use its full URL or a short reference, which looks like +`namespace/project-name#123`, where `namespace` is either a group or a username. + +To copy the objective or key result reference to your clipboard: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Plan > Issues**, then select your objective or key result to view it. +1. In the top right corner, select the vertical ellipsis (**{ellipsis_v}**), then select **Copy Reference**. + +You can now paste the reference into another description or comment. + +Read more about objective or key result references in [GitLab-Flavored Markdown](markdown.md#gitlab-specific-references). + +## Copy objective or key result email address + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. + +You can create a comment in an objective or key result by sending an email. +Sending an email to this address creates a comment that contains the email body. + +For more information about creating comments by sending an email and the necessary configuration, see +[Reply to a comment by sending email](discussions/index.md#reply-to-a-comment-by-sending-email). + +To copy the objective's or key result's email address: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the top right corner, select the vertical ellipsis (**{ellipsis_v}**), then select **Copy objective email address** or **Copy key result email address**. + ## Close an OKR When an OKR is achieved, you can close it. |