From 38b206b3f87bfd07eca679bbb5cabf4cc1155fe3 Mon Sep 17 00:00:00 2001 From: Petr Bokoc Date: Apr 11 2019 14:03:12 +0000 Subject: Add a section on epics --- diff --git a/modules/taiga/assets/images/createbacklog/epic-view-customization.png b/modules/taiga/assets/images/createbacklog/epic-view-customization.png new file mode 100644 index 0000000..9165466 Binary files /dev/null and b/modules/taiga/assets/images/createbacklog/epic-view-customization.png differ diff --git a/modules/taiga/assets/images/createbacklog/epic-view.png b/modules/taiga/assets/images/createbacklog/epic-view.png new file mode 100644 index 0000000..381cb07 Binary files /dev/null and b/modules/taiga/assets/images/createbacklog/epic-view.png differ diff --git a/modules/taiga/assets/images/createbacklog/new-epic.png b/modules/taiga/assets/images/createbacklog/new-epic.png new file mode 100644 index 0000000..3181c7d Binary files /dev/null and b/modules/taiga/assets/images/createbacklog/new-epic.png differ diff --git a/modules/taiga/nav.adoc b/modules/taiga/nav.adoc index e7db060..a564d48 100644 --- a/modules/taiga/nav.adoc +++ b/modules/taiga/nav.adoc @@ -2,6 +2,7 @@ * xref:create_backlog.adoc[Working with tickets] ** xref:create_backlog.adoc#add-individual-us[Adding an individual user story] ** xref:create_backlog.adoc#add-bulk-us[Adding user stories in bulk] +** xref:create_backlog.adoc#epics[Working with epics] ** xref:create_backlog.adoc#issues[Issues] ** xref:create_backlog.adoc#sprints[Sprints] * xref:wiki.adoc[Taiga Wiki] diff --git a/modules/taiga/pages/create_backlog.adoc b/modules/taiga/pages/create_backlog.adoc index f124b0a..da62716 100644 --- a/modules/taiga/pages/create_backlog.adoc +++ b/modules/taiga/pages/create_backlog.adoc @@ -93,6 +93,59 @@ You can create a single issue or use bulk insert to create many at once. Items available in the drop-down menus such as Type, Severity, and Priority can be customized in the xref:admin.adoc[admin interface]. Tags work the same way they do in user stories. +[[epics]] +== Working with epics +Epics are collections of user stories. +When a user story is too complex to really be tracked as just a single entity, you can break it down into multiple user stories (and in turn break those down into tasks), and add them into a single epic in order to track them in the **Epics** screen. + +The Epics module is not enabled by default on neither Scrum nor Kanban boards. +Go to the xref:admin.adoc#admin-modules[Modules] screen in the admin interface to enable it. + +When the module is enabled, click the Epics icon in the left sidebar, and add your first epic using the **{plus} Add Epic** button in the top right corner. + +.The New Epic dialog +image::{imagesdir}/createbacklog/new-epic.png[] + +The creation process is similar to creating an individual user story: provide a descriptive name, status, tags, and description, and click **Create Epic**. +After that, you will return to the Epics screen, and see your new epic in the list. +At this point the epic is empty, and you must add user stories to it. + +To do so, click the name of the epic in the list (the name exactly). +Then, click the **{plus}** button next to the **Related user stories** heading, + +Then, either add one or more new user stories in the **New user story** tab (click the "list" button to add new user stories in bulk), or pick an existing user story. +Note that you can only add one existing user story to an epic at once. +Click **Save** to add your user stories and return to the epic details page, where you can either continue adding more user stories (or tags or attachments), or return to the list of epics. + +Back in the list of epics, clicking any row with an epic that has at least one user story associated with it will expand it and show all those user stories. + +.The Epics view +image::{imagesdir}/createbacklog/epic-view.png[] + +The list also displays a progress bar for each epic as well as each individual user story when expanded, allowing you to track them at a glance. +The progress bar displays the percentage of tickets associated with the epic which are in the Done state. + +[NOTE] +==== +If a user story contains any subtasks, they must have their status individually set to **Done** in order to show up as done in the progress bar. +Setting only the user story itself to **Done** does not count. +At the same time, if the user story is _not_ set to **Done** but all of its subtasks are, the Epics view still counts it as completely done. +==== + +Project members with sufficient permissions can vote on each epic using the arrows on the left side of each epic entry. +Click the arrow again to remove your vote. + +You can rearrange the order in which epics are displayed by dragging and dropping them in the Epics screen. +You can not use the list of epics to rearrange the order of individual user stories in each epic; to do so, open the epic's details page and rearrange the **Related user stories** list. + +Finally, you can customize the Epics view using the sliders under the **View options** drop down menu in the top right corner. + +.Customizing the Epics view +image::{imagesdir}/createbacklog/epic-view-customization.png[] + +Finished epics (those which have the Done status set) are normally displayed in the list with a strikethrough; you can remove them using the View Options menu. +To completely delete an epic, open its page by clicking its name, and click the red recycle bin icon in the right sidebar. + [[sprints]] == Sprints Sprints are an integral part of Scrum.