From 6f923251f530d9a96d98d632f069fd2ecf31dda2 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Thu, 20 Apr 2017 16:28:05 +0000 Subject: Milestones documentation refactor --- .../project/milestones/img/milestone_create.png | Bin 0 -> 40591 bytes .../milestones/img/milestone_group_create.png | Bin 0 -> 35526 bytes doc/user/project/milestones/index.md | 49 +++++++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 doc/user/project/milestones/img/milestone_create.png create mode 100644 doc/user/project/milestones/img/milestone_group_create.png create mode 100644 doc/user/project/milestones/index.md (limited to 'doc/user/project/milestones') diff --git a/doc/user/project/milestones/img/milestone_create.png b/doc/user/project/milestones/img/milestone_create.png new file mode 100644 index 00000000000..beb2caa897f Binary files /dev/null and b/doc/user/project/milestones/img/milestone_create.png differ diff --git a/doc/user/project/milestones/img/milestone_group_create.png b/doc/user/project/milestones/img/milestone_group_create.png new file mode 100644 index 00000000000..7aaa7c56c15 Binary files /dev/null and b/doc/user/project/milestones/img/milestone_group_create.png differ diff --git a/doc/user/project/milestones/index.md b/doc/user/project/milestones/index.md new file mode 100644 index 00000000000..9502b9885c1 --- /dev/null +++ b/doc/user/project/milestones/index.md @@ -0,0 +1,49 @@ +# Milestones + +Milestones allow you to organize issues and merge requests into a cohesive group, +optionally setting a due date. A common use is keeping track of an upcoming +software version. Milestones can be created per-project or per-group. + +## Creating a project milestone + +>**Note:** +You need [Master permissions](../../permissions.md) in order to create a milestone. + +You can find the milestones page under your project's **Issues ➔ Milestones**. +To create a new milestone, simply click the **New milestone** button when in the +milestones page. A milestone can have a title, a description and start/due dates. +Once you fill in all the details, hit the **Create milestone** button. + +>**Note:** +The start/due dates are required if you intend to use [Burndown charts](#burndown-charts). + +![Creating a milestone](img/milestone_create.png) + +## Creating a group milestone + +>**Note:** +You need [Master permissions](../../permissions.md) in order to create a milestone. + +You can create a milestone for several projects in the same group simultaneously. +On the group's **Issues ➔ Milestones** page, you will be able to see the status +of that milestone across all of the selected projects. To create a new milestone +for selected projects in the group, click the **New milestone** button. The +form is the same as when creating a milestone for a specific project with the +addition of the selection of the projects you want to inherit this milestone. + +![Creating a group milestone](img/milestone_group_create.png) + +## Special milestone filters + +In addition to the milestones that exist in the project or group, there are some +special options available when filtering by milestone: + +* **No Milestone** - only show issues or merge requests without a milestone. +* **Upcoming** - show issues or merge request that belong to the next open + milestone with a due date, by project. (For example: if project A has + milestone v1 due in three days, and project B has milestone v2 due in a week, + then this will show issues or merge requests from milestone v1 in project A + and milestone v2 in project B.) +* **Started** - show issues or merge requests from any milestone with a start + date less than today. Note that this can return results from several + milestones in the same project. -- cgit v1.2.1