Commit 5fdf7707 authored by Kushal Pandya's avatar Kushal Pandya Committed by Achilleas Pipinellis

Update documentation for Epics filtered search and Group Roadmap

parent 72ee0b60
......@@ -54,6 +54,7 @@ GitLab.com is our SaaS offering. It's hosted, managed, and administered by GitLa
- [Groups](user/group/index.md): Organize your projects in groups.
- [Subgroups](user/group/subgroups/index.md)
- **(Ultimate)** [Epics](user/group/epics/index.md)
- **(Ultimate)** [Roadmap](user/group/roadmap/index.md)
- **(Starter/Premium)** [Contribution Analytics](user/group/contribution_analytics/index.md): See detailed statistics of group contributors.
- [Search through GitLab](user/search/index.md): Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards.
- **(Starter/Premium)** [Advanced Global Search](user/search/advanced_global_search.md): Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance.
......
......@@ -6,6 +6,8 @@ Epics let you manage your portfolio of projects more efficiently and with less
effort by tracking groups of issues that share a theme, across projects and
milestones.
![epics list view](img/epics_list_view.png)
## Creating an epic
A paginated list of epics is available in each group from where you can create
......@@ -57,6 +59,27 @@ link in the issue sidebar.
![containing epic](img/containing_epic.png)
## Searching for an epic from epics list page
> Introduced in [GitLab Ultimate][ee] 10.5.
You can search for an epic from the list of epics using filtered search bar (similar to
that of Issues and Merge requests) based on following parameters:
- Title or description
- Author name / username
![epics search](img/epics_search.png)
To search, go to the list of epics and click on the field **Search or filter results...**.
It will display a dropdown menu, from which you can add an author. You can also enter plain
text to search by epic title or description. When done, press <kbd>Enter</kbd> on your
keyboard to filter the list.
You can also sort epics list by **Created date** or **Last updated**.
![epics sort](img/epics_sort.png)
## Permissions
If you have access to view an epic and have access to view an issue already
......
# Roadmap
> Introduced in [GitLab Ultimate][ee] 10.5.
An Epic within a group containing **Planned start date** and/or **Planned finish date**
can be visualized in a form of a timeline (e.g. a Gantt chart). The Epics Roadmap page
shows such a visualization for all the epics which are under a group and/or its subgroups.
![roadmap view](img/roadmap_view.png)
## Timeline duration
![roadmap timeline](img/roadmap_timeline.png)
Roadmap shows epics which have planned start or finish dates _falling within_ or
_going through_ the **past 3 months** or **next 3 months** from today, where _today_
is shown by the vertical red line in the timeline. The dates underneath the month on
the timeline header represent the starting day (Sunday) of the week.
## Timeline bar for an epic
The timeline bar indicates the approximate position of an epic based on its planned start
and finish date. If an epic doesn't have a planned finish date, the timeline bar fades
away towards the future. Similarly, if an epic doesn't have a planned start date, the
timeline bar becomes more visible as it approaches the epic's planned finish date on the
timeline.
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