BigW Consortium Gitlab

index.md 5.45 KB
Newer Older
1
# Issues
Marcia Ramos committed
2

Victor Wu committed
3
The GitLab Issue Tracker is an advanced and complete tool
Marcia Ramos committed
4 5 6 7
for tracking the evolution of a new idea or the process
of solving a problem.

It allows you, your team, and your collaborators to share
8
and discuss proposals before and while implementing them.
Marcia Ramos committed
9

Marcia Ramos committed
10
GitLab Issues and the GitLab Issue Tracker are available in all
Marcia Ramos committed
11 12 13
[GitLab Products](https://about.gitlab.com/products/) as
part of the [GitLab Workflow](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).

14
## Use cases
Marcia Ramos committed
15 16 17 18 19 20 21 22 23 24 25

Issues can have endless applications. Just to exemplify, these are
some cases for which creating issues are most used:

- Discussing the implementation of a new idea
- Submitting feature proposals
- Asking questions
- Reporting bugs and malfunction
- Obtaining support
- Elaborating new code implementations

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
See also the blog post "[Always start a discussion with an issue](https://about.gitlab.com/2016/03/03/start-with-an-issue/)".

### Keep private things private

For instance, let's assume you have a public project but want to start a discussion on something
you don't want to be public. With [Confidential Issues](#confidential-issues),
you can discuss private matters among the project members, and still keep
your project public, open to collaboration.

### Streamline collaboration

With [Multiple Assignees for Issues](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html),
available in [GitLab Enterprise Edition Starter](https://about.gitlab.com/gitlab-ee/)
you can streamline collaboration and allow shared responsibilities to be clearly displayed.
All assignees are shown across your workflows and receive notifications (as they
would as single assignees), simplifying communication and ownership.

### Consistent collaboration

Create [issue templates](#issue-templates) to make collaboration consistent and
containing all information you need. For example, you can create a template
for feature proposals and another one for bug reports.
Marcia Ramos committed
48

Marcia Ramos committed
49
## Issue Tracker
Marcia Ramos committed
50

Marcia Ramos committed
51 52 53 54 55 56 57 58 59
The Issue Tracker is the collection of opened and closed issues created in a project.
It is available for all projects, from the moment the project is created.

Find the issue tracker by navigating to your **Project's homepage** > **Issues**.

### Issues per project

When you access your project's issues, GitLab will present them in a list,
and you can use the tabs available to quickly filter by open and closed issues.
Marcia Ramos committed
60

Victor Wu committed
61
![Project issues list view](img/project_issues_list_view.png)
Marcia Ramos committed
62

Marcia Ramos committed
63 64 65
You can also [search and filter](../../search/index.md#issues-and-merge-requests-per-project) the results more deeply with GitLab's search capacities.

### Issues per group
Victor Wu committed
66

Victor Wu committed
67 68 69 70 71 72
View all the issues in a group (that is, all the issues across all projects in that
group) by navigating to **Group > Issues**. This view also has the open and closed
issue tabs.

![Group Issues list view](img/group_issues_list_view.png)

Marcia Ramos committed
73 74 75 76 77 78 79 80
## GitLab Issues Functionalities

The image bellow illustrates how an issue looks like:

![Issue view](img/issues_main_view.png)

Learn more about it on the [GitLab Issues Functionalities documentation](issues_functionalities.md).

81
## New issue
Marcia Ramos committed
82 83 84 85 86

Read through the [documentation on creating issues](create_new_issue.md).

## Closing issues

87
Learn distinct ways to [close issues](closing_issues.md) in GitLab.
Marcia Ramos committed
88

89 90 91 92
## Moving issues

Read through the [documentation on moving issues](moving_issues.md).

93 94 95 96
## Create a merge request from an issue

Learn more about it on the [GitLab Issues Functionalities documentation](issues_functionalities.md#18-new-merge-request).

Marcia Ramos committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
## Search for an issue

Learn how to [find an issue](../../search/index.md) by searching for and filtering them.

## Advanced features

### Confidential Issues

Whenever you want to keep the discussion presented in a
issue within your team only, you can make that
[issue confidential](confidential_issues.md). Even if your project
is public, that issue will be preserved. The browser will
respond with a 404 error whenever someone who is not a project
member with at least [Reporter level](../../permissions.md#project) tries to
access that issue's URL.

Learn more about them on the [confidential issues documentation](confidential_issues.md).

### Issue templates

Create templates for every new issue. They will be available from
the dropdown menu **Choose a template** when you create a new issue:

![issue template](img/issue_template.png)

Learn more about them on the [issue templates documentation](../../project/description_templates.md#creating-issue-templates).

### Crosslinking issues

Learn more about [crosslinking](crosslinking_issues.md) issues and merge requests.

128
### Issue Board
Marcia Ramos committed
129 130 131 132 133 134 135 136 137 138 139

The [GitLab Issue Board](https://about.gitlab.com/features/issueboard/) is a way to
enhance your workflow by organizing and prioritizing issues in GitLab.

![Issue board](img/issue_board.png)

Find GitLab Issue Boards by navigating to your **Project's Dashboard** > **Issues** > **Board**.

Read through the documentation for [Issue Boards](../issue_board.md)
to find out more about this feature.

140 141
With [GitLab Enterprise Edition Starter](https://about.gitlab.com/gitlab-ee/), you can also
create various boards per project with [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards).
Marcia Ramos committed
142

143 144 145 146 147 148
### External Issue Tracker

Alternatively to GitLab's built-in Issue Tracker, you can also use an [external
tracker](../../../integration/external-issue-tracker.md) such as Jira, Redmine,
or Bugzilla.

Marcia Ramos committed
149 150 151
### Issue's API

Read through the [API documentation](../../../api/issues.md).