Skip to content
Snippets Groups Projects
Verified Commit a62349f1 authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski Committed by GitLab
Browse files

Merge branch '438577-add-work-item-time-tracking-docs' into 'master'

Add time tracking documentation for tasks

See merge request !153140



Merged-by: default avatarMarcin Sedlak-Jakubowski <msedlakjakubowski@gitlab.com>
Approved-by: default avatarMarcin Sedlak-Jakubowski <msedlakjakubowski@gitlab.com>
Reviewed-by: default avatarCoung Ngo <cngo@gitlab.com>
Reviewed-by: default avatarMarcin Sedlak-Jakubowski <msedlakjakubowski@gitlab.com>
Co-authored-by: default avatarCoung Ngo <cngo@gitlab.com>
parents 2cf03a6d d3e267f2
No related branches found
No related tags found
2 merge requests!162233Draft: Script to update Topology Service Gem,!153140Add time tracking documentation for tasks
Pipeline #1298059182 failed
Pipeline: E2E Omnibus GitLab EE

#1298093723

    Pipeline: E2E CNG

    #1298064845

      Pipeline: E2E GDK

      #1298061519

        +28
        ......@@ -10,17 +10,21 @@ DETAILS:
        **Tier:** Free, Premium, Ultimate
        **Offering:** GitLab.com, Self-managed, GitLab Dedicated
        You can estimate and track the time you spend on [issues](issues/index.md)
        and [merge requests](merge_requests/index.md).
        > - Time tracking for tasks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438577) in GitLab 17.0.
        Then you can [view a report](#view-a-time-tracking-report) that shows totals over time.
        You can estimate and track the time you spend on an item, such as:
        - [Issue](issues/index.md)
        - [Task](../tasks.md)
        - [Merge request](merge_requests/index.md)
        Then you can [view a report](#view-an-items-time-tracking-report) that shows totals over time.
        Use time tracking for these tasks:
        - Record the time spent working on an issue or a merge request.
        - Add or update an estimate of the total time to complete an issue or a merge
        request.
        - View a breakdown of time spent working on an issue or a merge request.
        - Record the time spent working on an item.
        - Add or update an estimate of the total time to complete an item.
        - View a breakdown of time spent working on an item.
        You don't have to indicate an estimate to enter the time spent, and vice versa.
        ......@@ -28,13 +32,13 @@ To enter and remove time tracking data, you must use [quick actions](quick_actio
        Type all quick actions on their own lines.
        If you use any quick action more than once in a single comment, only its last occurrence is applied.
        You can see the data about time tracking on the right sidebar in issues and merge requests:
        You can see the data about time tracking on the right sidebar:
        ![Time tracking in the sidebar](img/time_tracking_sidebar_v13_12.png)
        ## Estimates
        The estimate is designed to show the total time needed to complete an issue or merge request.
        The estimate is designed to show the total time needed to complete an item.
        You can see the estimated time remaining when you hover over the time tracking information in the right sidebar.
        ......@@ -45,6 +49,7 @@ You can see the estimated time remaining when you hover over the time tracking i
        Prerequisites:
        - In issues, you must have at least the Reporter role for the project.
        - In tasks, you must have at least the Reporter role for the project.
        - In merge requests, you must have at least the Developer role for the project.
        To enter an estimate, use the `/estimate` [quick action](quick_actions.md), followed by the time.
        ......@@ -53,7 +58,7 @@ For example, if you need to enter an estimate of 1 month, 2 weeks, 3 days, 4 hou
        type `/estimate 1mo 2w 3d 4h 5m`.
        Check the [time units you can use](#available-time-units).
        An issue or a merge request can have only one estimate.
        An item can have only one estimate.
        Every time you enter a new time estimate, it overwrites the previous value.
        ### Remove an estimate
        ......@@ -61,6 +66,7 @@ Every time you enter a new time estimate, it overwrites the previous value.
        Prerequisites:
        - In issues, you must have at least the Reporter role for the project.
        - In tasks, you must have at least the Reporter role for the project.
        - In merge requests, you must have at least the Developer role for the project.
        To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_actions.md).
        ......@@ -70,9 +76,9 @@ To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_
        As you work, you can log the time you've spent.
        Every new time spent entry is added to the current total time spent for the
        issue or the merge request.
        issue, task, or the merge request.
        The total amount of time spent on an issue or merge request cannot exceed a year.
        The total amount of time spent on an issue, task, or merge request cannot exceed a year.
        ### Add time spent
        ......@@ -96,7 +102,7 @@ To add a time entry using the user interface:
        1. Select **Save**.
        The **Spent** total in the sidebar is updated and you can view all entries in a [time tracking report](#view-a-time-tracking-report).
        The **Spent** total in the sidebar is updated and you can view all entries in a [time tracking report](#view-an-items-time-tracking-report).
        #### Using a quick action
        ......@@ -106,7 +112,7 @@ For example, if you need
        to log 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes, type `/spend 1mo 2w 3d 4h 5m`.
        Check the [time units you can use](#available-time-units).
        To add a [time tracking report](#view-a-time-tracking-report) entry with a note, create a comment
        To add a [time tracking report](#view-an-items-time-tracking-report) entry with a note, create a comment
        with a description and the quick action.
        It then shows in the time tracking report **Summary/Notes** column. For example:
        ......@@ -156,20 +162,25 @@ Prerequisites:
        To delete all the time spent at once, use the `/remove_time_spent` [quick action](quick_actions.md).
        ## View a time tracking report
        ## View an item's time tracking report
        To view a time tracking report of time spent on an item:
        - For an issue or merge request:
        ### For an issue or merge request
        1. Go to an issue or a merge request.
        1. In the right sidebar, select **Time tracking report**.
        To view a time tracking report of time spent on an issue or merge request:
        - For a task:
        1. Go to an issue or a merge request.
        1. In the right sidebar, select **Time tracking report**.
        1. Go to a task.
        1. In the right sidebar, select the time next to **Spent**.
        ![Time tracking report](img/time_tracking_report_v15_1.png)
        The breakdown of spent time displayed is limited to a maximum of 100 entries.
        ### Global time tracking report
        ## Global time tracking report
        DETAILS:
        **Status**: Experiment
        ......@@ -182,7 +193,7 @@ On self-managed GitLab, by default this feature is not available. To make it ava
        On GitLab.com, this feature is available. On GitLab Dedicated, this feature is not available.
        This feature is not ready for production use.
        View a report of time spent in issues and merge requests across all of GitLab.
        View a report of time spent in issues, tasks, and merge requests across all of GitLab.
        This feature is an [experiment](../../policy/experiment-beta-support.md).
        If you find a bug, let us know in the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/435222).
        ......
        ......@@ -348,6 +348,12 @@ To add a task to an iteration:
        1. Next to **Iteration**, select **Add to iteration**.
        1. From the dropdown list, select the iteration to be associated with the task.
        ## Set time tracking
        > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438577) in GitLab 17.0.
        To set time tracking, refer to the [time tracking page](project/time_tracking.md)
        ## View task system notes
        > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378949) in GitLab 15.7 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default.
        ......
        0% Loading or .
        You are about to add 0 people to the discussion. Proceed with caution.
        Finish editing this message first!
        Please register or to comment