diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-08-20 18:21:30 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-08-22 16:09:26 +0300 |
commit | fa72b5fa1481f49758cef45fa37c6d1d4e261e3a (patch) | |
tree | e95823429e770c732f3bd126ed1ded1f97c1a608 /doc/user/project/issue_board.md | |
parent | 3d1b24767b292af2bcadd3de728abd9a1d08cdb6 (diff) | |
download | gitlab-ce-fa72b5fa1481f49758cef45fa37c6d1d4e261e3a.tar.gz |
Fix typos and grammar
Diffstat (limited to 'doc/user/project/issue_board.md')
-rw-r--r-- | doc/user/project/issue_board.md | 49 |
1 files changed, 27 insertions, 22 deletions
diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index c0b040c3c07..33db21d442b 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -17,13 +17,14 @@ issue tracker. Below is a table of the definitions used for GitLab's Issue Board. -| How we call it | What it means | +| What we call it | What it means | | -------------- | ------------- | | **Issue Board** | It represents a different view for your issues. It can have multiple lists with each list consisting of issues represented by cards. | | **List** | Each label that exists in the issue tracker can have its own dedicated list. Every list is named after the label it is based on and is represented by a column which contains all the issues associated with that label. You can think of a list like the results you get when you filter the issues by a label in your issue tracker. | -| **Card** | Every card represents an issue and it is shown under the list for which it has a label for. The information you can see on a card consists of the issue number, the issue title, the assignee and the labels associated with it. You can drag cards around from one list to another. Issues inside lists are [ordered by priority](labels.md#prioritize-labels). | +| **Card** | Every card represents an issue and it is shown under the list for which it has a label. The information you can see on a card consists of the issue number, the issue title, the assignee and the labels associated with it. You can drag cards around from one list to another. Issues inside lists are [ordered by priority](labels.md#prioritize-labels). | -There are three types of lists, of which two are default: +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. @@ -42,7 +43,8 @@ In short, here's a list of actions you can take in an Issue Board: - Drag and reorder the lists themselves. - Change issue labels on-the-fly while dragging issues between lists. - Close an issue if you drag it to the **Done** list. -- Add a new list from a non-existing label by creating the label on-the-fly. +- Create a new list from a non-existing label by [creating the label on-the-fly](#creating-a-new-list) + within the Issue Board. - [Filter issues](#filtering-issues) that appear across your Issue Board. If you are not able to perform one or more of the things above, make sure you @@ -51,16 +53,17 @@ 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 special lists (**Backlog** and **Done**) and a welcoming message that gives -you two options. You can either create a predefined set of labels and add their -corresponding lists to the Issue Board or opt-out and use your own lists. +two default lists (**Backlog** and **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. ![Issue Board welcome message](img/issue_board_welcome_message.png) -If you choose to use and add the default lists, they will appear as empty +If you choose to use and create the predefined lists, they will appear as empty because the labels associated to them will not exist up until that moment, -which means the system has no way of populating them automatically. It'll be -the users' job to add individual issues to them. +which means the system has no way of populating them automatically. That's of +course if the predefined labels don't already exist. If any of them does exist, +the list will be created and filled with the issues that have that label. ## Creating a new list @@ -73,7 +76,7 @@ Simply choose the label to create the list from. The new list will be inserted at the end of the lists, before **Done**. Moving and reordering lists is as easy as dragging them around. -To create a list for a label that doesn't exist yet, simply create the label by +To create a list for a label that doesn't yet exist, simply create the label by choosing **Create new label**. The label will be created on-the-fly and it will be immediately added to the dropdown. You can now choose it to create a list. @@ -83,7 +86,7 @@ To delete a list from the Issue Board use the small trash icon that is present 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. +list view that is removed. You can always add it back later if you need. ## Searching issues in the Backlog list @@ -113,7 +116,7 @@ You can filter by author, assignee, milestone and label. ## Creating workflows -By adding new lists, you can create workflows. As lists in Issue Boards are +By reordering your lists, you can create workflows. As lists in Issue Boards are based on labels, it works out of the box with your existing issues. So if you've already labeled things with 'Backend' and 'Frontend', the issue will appear in the lists as you create them. In addition, this means you can easily move @@ -121,9 +124,10 @@ something between lists by changing a label. A typical workflow of using the Issue Board would be: -1. You have [created labels] so that you can easily categorize your issues. +1. You have [created][create-labels] and [prioritized][label-priority] labels + so that you can easily categorize your issues. 1. You have a bunch of issues (ideally labeled). -1. You visit the Issue Board and start [adding lists](#adding-a-new-list) as to +1. You visit the Issue Board and start [creating lists](#creating-a-new-list) to create a workflow. 1. You move issues around in lists so that your team knows who should be working on what issue. @@ -132,7 +136,7 @@ A typical workflow of using the Issue Board would be: 1. When the issue is finally resolved, the issue is moved to the **Done** list and gets automatically closed. -For instance you can add a list based on the label of 'Frontend' and one for +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 worked on by the designers. Then, once they're done, all they have to do is @@ -148,7 +152,7 @@ to another list the label changes and a system not is recorded. ## Permissions [Developers and up](../permissions.md) can use all the functionality of the -Issue Board, that is add/remove lists and drag issues around. +Issue Board, that is create/delete lists and drag issues around. ## Tips @@ -158,13 +162,13 @@ A few things to remember: - Moving an issue between lists removes the label from the list it came from and adds the label from the list it goes to. - When moving a card to **Done**, the label of the list it came from is removed - the issue gets closed. -- An issue can exist in multiple lists if it has more than one labels. + and the issue gets closed. +- An issue can exist in multiple lists if it has more than one label. - Lists are populated with issues automatically if the issues are labeled. -- Clicking on the issue title inside a card will get you to that issue. +- Clicking on the issue title inside a card will take you to that issue. - Clicking on a label inside a card will quickly filter the entire Issue Board and show only the issues from all lists that have that label. -- Issues inside lists are [ordered by priority](labels.md#prioritize-labels). +- Issues inside lists are [ordered by priority][label-priority]. - For performance and visibility reasons, each list shows the first 20 issues by default. If you have more than 20 issues start scrolling down and the next 20 will appear. @@ -173,4 +177,5 @@ A few things to remember: [labels]: ./labels.md [scrum]: https://en.wikipedia.org/wiki/Scrum_(software_development) [kanban]: https://en.wikipedia.org/wiki/Kanban_(development) -[created labels]: ./labels.md#create-new-labels +[create-labels]: ./labels.md#create-new-labels +[label-priority]: ./labels.md#prioritize-labels |