Commit 9afb93cb authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski Committed by Suzanne Selhorn

CTRT edits to Time tracking doc

parent e37f5d99
...@@ -8,76 +8,81 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,76 +8,81 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Time tracking **(FREE)** # Time tracking **(FREE)**
With time tracking you can track estimates and time spent on issues and merge You can estimate and track the time you spend on [issues](issues/index.md)
requests in GitLab. and [merge requests](merge_requests/index.md).
Then you can [view a report](#view-a-time-tracking-report) that shows totals over time.
Use time tracking for these tasks: Use time tracking for these tasks:
- Record the time spent working on an issue or a merge request. - 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 - Add or update an estimate of the total time to complete an issue or a merge
request. request.
- View a breakdown of time spent working on an issue or a merge request. - View a breakdown of time spent working on an issue or a merge request.
You don't have to indicate an estimate to enter the time spent, and vice versa. You don't have to indicate an estimate to enter the time spent, and vice versa.
Data about time tracking shows up on the issue and merge request sidebar: To enter and remove time tracking data, you must use [quick actions](quick_actions.md).
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:
![Time tracking in the sidebar](img/time_tracking_sidebar_v13_12.png) ![Time tracking in the sidebar](img/time_tracking_sidebar_v13_12.png)
## How to enter data ## Estimates
Time tracking uses two [quick actions](quick_actions.md): `/spend` and `/estimate`. The estimate is designed to show the total time needed to complete an issue or merge request.
If you use either quick action more than once in a single comment, only the last occurrence is applied. You can see the estimated time remaining when you hover over the time tracking information in the right sidebar.
Below is an example of how you can use those new quick actions inside a comment. ![Estimated time remaining](img/remaining_time_v14_2.png)
![Time tracking example in a comment](img/time_tracking_example_v12_2.png) ### Add an estimate
Adding time entries (time spent or estimates) is limited to project members Prerequisites:
with [Reporter and higher permission levels](../permissions.md).
### Estimates - You must have at least the Reporter role for the project.
To enter an estimate, type `/estimate`, followed by the time. To enter an estimate, use the `/estimate` [quick action](quick_actions.md), followed by the time.
For example, if you need to enter an estimate of 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes, For example, if you need to enter an estimate of 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes,
type `/estimate 1mo 2w 3d 4h 5m`. type `/estimate 1mo 2w 3d 4h 5m`.
Check the [time units you can use](#configuration). Check the [time units you can use](#available-time-units).
The estimate is designed to show the total estimated time. The estimated An issue or a merge request can have only one estimate.
time remaining is automatically calculated and displayed when hovering over Every time you enter a new time estimate, it overwrites the previous value.
the time tracking information in the right sidebar.
![Estimated time remaining](img/remaining_time_v14_2.png) ### Remove an estimate
An issue or a merge request can have only one estimate. Every time you enter a Prerequisites:
new time estimate, it overwrites the previous value.
To remove an estimation entirely, use `/remove_estimate`. - You must have at least the Reporter role for the project.
### Time spent To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_actions.md).
To enter time spent, type `/spend`, followed by the time. ## Time spent
For example, if you need As you work, you can log the time you've spent.
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](#configuration).
Every new time spent entry is added to the current total time spent for the Every new time spent entry is added to the current total time spent for the
issue or the merge request. issue or the merge request.
To subtract time, enter a negative value. For example, `/spend -3d` removes three ### Add time spent
days from the total time spent. You can't go below 0 minutes of time spent,
so if you remove more time than already entered, GitLab ignores the subtraction.
You can log time in the past by providing a date after the time. Prerequisites:
For example, if you want to log 1 hour of time spent on the 31 January 2021,
you would type `/spend 1h 2021-01-31`. If you supply a date in the future, the - You must have at least the Reporter role for the project.
command fails and no time is logged.
To enter time spent, use the `/spend` [quick action](quick_actions.md), followed by the time.
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 timelog entry with a note, create a comment with a description and the quick action. To add a [time tracking report](#view-a-time-tracking-report) entry with a note, create a comment
It then shows in the timelog "Summary/Notes" column. For example: with a description and the quick action.
It then shows in the time tracking report **Summary/Notes** column. For example:
```plaintext ```plaintext
Draft MR and respond to initial comments Draft MR and respond to initial comments
...@@ -85,7 +90,29 @@ Draft MR and respond to initial comments ...@@ -85,7 +90,29 @@ Draft MR and respond to initial comments
/spend 30m /spend 30m
``` ```
To remove all the time spent at once, use `/remove_time_spent`. ### Add time spent on a specific date
Prerequisites:
- You must have at least the Reporter role for the project.
You can log time in the past by providing a date after the time.
For example, to log 1 hour of time spent on 31 January 2021,
type `/spend 1h 2021-01-31`.
If you type a future date, no time is logged.
### Remove time spent
Prerequisites:
- You must have at least the Reporter role for the project.
To subtract time, enter a negative value. For example, `/spend -3d` removes three
days from the total time spent. You can't go below 0 minutes of time spent,
so if you remove more time than already entered, GitLab ignores the subtraction.
To remove all the time spent at once, use the `/remove_time_spent` [quick action](quick_actions.md).
## View a time tracking report ## View a time tracking report
...@@ -97,31 +124,33 @@ Prerequisites: ...@@ -97,31 +124,33 @@ Prerequisites:
- You must have at least the [Reporter role](../permissions.md#project-members-permissions) for a project. - You must have at least the [Reporter role](../permissions.md#project-members-permissions) for a project.
To view a time tracking report, go to an issue or a merge request and select **Time tracking report** To view a time tracking report:
in the right sidebar.
1. Go to an issue or a merge request.
1. In the right sidebar, select **Time tracking report**.
![Time tracking report](img/time_tracking_report_v13_12.png) ![Time tracking report](img/time_tracking_report_v13_12.png)
The breakdown of spent time is limited to a maximum of 100 entries. The breakdown of spent time is limited to a maximum of 100 entries.
## Configuration ## Available time units
The following time units are available: The following time units are available:
| Time unit | What to type | Default conversion rate | | Time unit | What to type | Conversion rate |
| --------- | ------------ | ----------------------- | | --------- | --------------------------- | -------------------- |
| Month | `mo` | 4w | | Year | `y`, `year`, or `years` | 8766h (365.25 × 24h) |
| Week | `w` | 5d | | Month | `mo`, `month`, or `months` | 160h (4w) |
| Day | `d` | 8h | | Week | `w`, `week`, or `weeks` | 40h (5d) |
| Hour | `h` | 60m | | Day | `d`, `day`, or `days` | 8h |
| Minute | `m` | | | Hour | `h`, `hour`, or `hours` | 60m |
| Minute | `m`, `minute`, or `minutes` | |
### Limit displayed units to hours **(FREE SELF)** ### Limit displayed units to hours **(FREE SELF)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29469/) in GitLab 12.1. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29469/) in GitLab 12.1.
In GitLab self-managed instances, you can limit the display of time units to In GitLab self-managed instances, you can limit the display of time units to hours.
hours.
To do so: To do so:
1. On the top bar, select **Menu > Admin**. 1. On the top bar, select **Menu > Admin**.
......
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