Skip to content
Snippets Groups Projects

Documentation for Issue Boards

Merged Documentation for Issue Boards
issue-boards-doc into master
Merged Achilleas Pipinellis requested to merge issue-boards-doc into master

What does this MR do?

Add documentation for issue boards.

What are the relevant issue numbers?

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on an old version of the diff
    • doc/user/project/issue_board.md 0 → 100644
    9 ## Overview
    10
    11 The Issue Board builds on GitLab's existing issue tracking functionality and
    12 leverages the power of [labels] by utilizing them as lists of the scrum board.
    13
    14 With the Issue Board you can have a different view of your issues while also
    15 maintaining the same filtering and sorting abilities you see across the
    16 issue tracker.
    17
    18 Below is a table of the definitions used for GitLab's Issue Board.
    19
    20 | How we call it | What it means |
    21 | -------------- | ------------- |
    22 | **Issue Board** | It represents a different view for your issues. It can have multiple lists with each list consisting of issues represented by cards. |
    23 | **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. |
    24 | **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). |
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on an old version of the diff
    • doc/user/project/issue_board.md 0 → 100644
    11 The Issue Board builds on GitLab's existing issue tracking functionality and
    12 leverages the power of [labels] by utilizing them as lists of the scrum board.
    13
    14 With the Issue Board you can have a different view of your issues while also
    15 maintaining the same filtering and sorting abilities you see across the
    16 issue tracker.
    17
    18 Below is a table of the definitions used for GitLab's Issue Board.
    19
    20 | How we call it | What it means |
    21 | -------------- | ------------- |
    22 | **Issue Board** | It represents a different view for your issues. It can have multiple lists with each list consisting of issues represented by cards. |
    23 | **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. |
    24 | **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). |
    25
    26 There are three types of lists, of which two are default:
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on an old version of the diff
    • doc/user/project/issue_board.md 0 → 100644
    48 If you are not able to perform one or more of the things above, make sure you
    49 have the right [permissions](#permissions).
    50
    51 ## First time using the Issue Board
    52
    53 The first time you navigate to your Issue Board, you will be presented with the
    54 two special lists (**Backlog** and **Done**) and a welcoming message that gives
    55 you two options. You can either create a predefined set of labels and add their
    56 corresponding lists to the Issue Board or opt-out and use your own lists.
    57
    58 ![Issue Board welcome message](img/issue_board_welcome_message.png)
    59
    60 If you choose to use and add the default lists, they will appear as empty
    61 because the labels associated to them will not exist up until that moment,
    62 which means the system has no way of populating them automatically. It'll be
    63 the users' job to add individual issues to them.
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on an old version of the diff
    • doc/user/project/issue_board.md 0 → 100644
    93
    94 You can filter by author, assignee, milestone and label.
    95
    96 ## Creating workflows
    97
    98 By adding new lists, you can create workflows. As lists in Issue Boards are
    99 based on labels, it works out of the box with your existing issues. So if you've
    100 already labeled things with 'Backend' and 'Frontend', the issue will appear in
    101 the lists as you create them. In addition, this means you can easily move
    102 something between lists by changing a label.
    103
    104 A typical workflow of using the Issue Board would be:
    105
    106 1. You have [created labels] so that you can easily categorize your issues.
    107 1. You have a bunch of issues (ideally labeled).
    108 1. You visit the Issue Board and start [adding lists](#adding-a-new-list) as to
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on an old version of the diff
    • doc/user/project/issue_board.md 0 → 100644
    102 something between lists by changing a label.
    103
    104 A typical workflow of using the Issue Board would be:
    105
    106 1. You have [created labels] so that you can easily categorize your issues.
    107 1. You have a bunch of issues (ideally labeled).
    108 1. You visit the Issue Board and start [adding lists](#adding-a-new-list) as to
    109 create a workflow.
    110 1. You move issues around in lists so that your team knows who should be working
    111 on what issue.
    112 1. When the work by one team is done, the issue can be dragged to the next list
    113 so someone else can pick up.
    114 1. When the issue is finally resolved, the issue is moved to the **Done** list
    115 and gets automatically closed.
    116
    117 For instance you can add a
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
    • Please register or sign in to reply