gitlab-org--gitlab-foss/doc/user/project/issues/index.md

133 lines
4.8 KiB
Markdown
Raw Normal View History

2017-06-28 17:41:06 -04:00
# Issues
2017-05-08 04:35:38 -04:00
2017-08-18 16:26:49 -04:00
GitLab issues is an advanced and complete tool
2017-05-08 04:35:38 -04:00
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
2017-07-16 12:07:48 -04:00
and discuss proposals before and while implementing them.
2017-05-08 04:35:38 -04:00
2017-08-18 16:26:49 -04:00
GitLab issues is available in all
2017-05-08 04:35:38 -04:00
[GitLab Products](https://about.gitlab.com/products/) as
part of the [GitLab Workflow](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).
2017-07-16 12:07:48 -04:00
## Use cases
2017-05-08 04:35:38 -04:00
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
2017-07-16 12:07:48 -04:00
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.
2017-05-08 04:35:38 -04:00
2017-08-18 16:26:49 -04:00
## Issue list views, searching, and filtering
2017-05-08 04:35:38 -04:00
2017-08-18 16:26:49 -04:00
View all the issues within a project by navigating to **Project > Issues**.
There are tabs to quickly filter by open and closed issues.
2017-05-08 04:35:38 -04:00
2017-08-18 16:26:49 -04:00
![Project issues list view](img/project_issues_list_view.png)
2017-05-08 04:35:38 -04:00
2017-08-18 16:26:49 -04:00
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)
In both these list views, [search and filter the results]().
2017-05-08 04:35:38 -04:00
## 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).
2017-06-05 22:38:34 -04:00
## New issue
2017-05-08 04:35:38 -04:00
Read through the [documentation on creating issues](create_new_issue.md).
## Closing issues
2017-06-05 22:38:34 -04:00
Learn distinct ways to [close issues](closing_issues.md) in GitLab.
2017-05-08 04:35:38 -04:00
2017-05-20 07:10:49 -04:00
## Create a merge request from an issue
Learn more about it on the [GitLab Issues Functionalities documentation](issues_functionalities.md#18-new-merge-request).
2017-05-08 04:35:38 -04:00
## 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.
2017-06-05 22:38:34 -04:00
### Issue Board
2017-05-08 04:35:38 -04:00
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.
2017-07-16 12:07:48 -04:00
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).
2017-05-08 04:35:38 -04:00
### Issue's API
Read through the [API documentation](../../../api/issues.md).