Updated issue boards docs

This commit is contained in:
Phil Hughes 2017-02-09 14:28:47 +00:00
parent 110cd58999
commit 7a08456ee0
4 changed files with 13 additions and 17 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 KiB

View File

@ -31,7 +31,6 @@ Below is a table of the definitions used for GitLab's Issue Board.
There are three types of lists, the ones you create based on your labels, and
two default:
- **Backlog** (default): shows all issues that do not fall in one of the other lists. Always appears on the very left.
- **Done** (default): shows all closed issues. Always appears on the very right.
Label list: a list based on a label. It shows all issues with that label.
- Label list: a list based on a label. It shows all opened issues with that label.
@ -58,7 +57,7 @@ have the right [permissions](#permissions).
## First time using the Issue Board
The first time you navigate to your Issue Board, you will be presented with the
two default lists (**Backlog** and **Done**) and a welcoming message that gives
a default list (**Done**) and a welcoming message that gives
you two options. You can either create a predefined set of labels and create
their corresponding lists to the Issue Board or opt-out and use your own lists.
@ -93,23 +92,20 @@ in the list's heading. A confirmation dialog will appear for you to confirm.
Deleting a list doesn't have any effect in issues and labels, it's just the
list view that is removed. You can always add it back later if you need.
## Searching issues in the Backlog list
## Adding issues to lists
The very first time you start using the Issue Board, it is very likely your
issue tracker is already populated with labels and issues. In that case,
**Backlog** will have all the issues that don't belong to another list, and
**Done** will have all the closed ones.
You can bulk add issues to a list by clicking the **Add issues** button.
This opens up a modal window where you can select multiple issues and then
add these issues to the selected list. By default the first list is selected,
but this can be changed in the dropdown menu next to the **Add issues** button
in the modal.
For performance and visibility reasons, each list shows the first 20 issues
by default. If you have more than 20, you have to start scrolling down for the
next 20 issues to appear. This can be cumbersome if your issue tracker hosts
hundreds of issues, and for that reason it is easier to search for issues to
move from **Backlog** to another list.
Within this modal you can also issues. This is done by using the filters at the
top of the modal.
Start typing in the search bar under the **Backlog** list and the relevant
issues will appear.
You can filter by author, assignee, milestone and label.
![Issue Board search Backlog](img/issue_board_search_backlog.png)
![Bulk adding issues to lists](img/issue_boards_add_issues_modal.png)
## Filtering issues
@ -142,8 +138,8 @@ A typical workflow of using the Issue Board would be:
and gets automatically closed.
For instance you can create a list based on the label of 'Frontend' and one for
'Backend'. A designer can start working on an issue by dragging it from
**Backlog** to 'Frontend'. That way, everyone knows that this issue is now being
'Backend'. A designer can start working on an issue by dragging adding it to the
'Frontend' list. That way, everyone knows that this issue is now being
worked on by the designers. Then, once they're done, all they have to do is
drag it over to the next list, 'Backend', where a backend developer can
eventually pick it up. Once theyre done, they move it to **Done**, to close the