Commit 4eac38d4 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-repo-merge-23-project-issues' into 'master'

Docs: Merge EE doc/user/project/issues to CE

See merge request gitlab-org/gitlab-ce!27948
parents 79052662 03bd17e5
...@@ -65,6 +65,26 @@ In GitLab 11.7, we updated the format of the generated email address. ...@@ -65,6 +65,26 @@ In GitLab 11.7, we updated the format of the generated email address.
However the older format is still supported, allowing existing aliases However the older format is still supported, allowing existing aliases
or contacts to continue working._ or contacts to continue working._
## New issue via Service Desk **[PREMIUM]**
Enable [Service Desk](https://docs.gitlab.com/ee/user/project/service_desk.html) to your project and offer email support.
By doing so, when your customer sends a new email, a new issue can be created in
the appropriate project and followed up from there.
## New issue from the group-level Issue Tracker
Head to the Group dashboard and click "Issues" in the sidebar to visit the Issue Tracker
for all projects in your Group. Select the project you'd like to add an issue for
using the dropdown button at the top-right of the page.
![Select project to create issue](img/select_project_from_group_level_issue_tracker.png)
We'll keep track of the project you selected most recently, and use it as the default
for your next visit. This should save you a lot of time and clicks, if you mostly
create issues for the same project.
![Create issue from group-level issue tracker](img/create_issue_from_group_level_issue_tracker.png)
## New issue via URL with prefilled fields ## New issue via URL with prefilled fields
You can link directly to the new issue page for a given project, with prefilled You can link directly to the new issue page for a given project, with prefilled
......
# Export Issues to CSV **[STARTER]**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1126) in [GitLab Starter 9.0](https://about.gitlab.com/2017/03/22/gitlab-9-0-released/#export-issues-ees-eep).
Issues can be exported as CSV from GitLab and are sent to your default notification email as an attachment.
## Overview
**Export Issues to CSV** enables you and your team to export all the data collected from issues into
a **[comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values)** (CSV) file,
which stores tabular data in plain text.
> _CSVs are a handy way of getting data from one program to another where one program cannot read the other ones normal output._ [Ref](https://www.quora.com/What-is-a-CSV-file-and-its-uses)
CSV files can be used with any plotter or spreadsheet-based program, such as Microsoft Excel,
Open Office Calc, or Google Spreadsheets.
## Use cases
Among numerous use cases for exporting issues for CSV, we can name a few:
- Make a snapshot of issues for offline analysis or to communicate with other teams who may not be in GitLab
- Create diagrams, graphs, and charts from the CSV data
- Present the data in any other format for auditing or sharing reasons
- Import the issues elsewhere to a system outside of GitLab
- Long-term issues' data analysis with multiple snapshots created along the time
- Use the long-term data to gather relevant feedback given in the issues, and improve your product based on real metrics
## Choosing which issues to include
From the issues page you can narrow down which issues to export using the search bar, along with the All/Open/Closed tabs. All issues returned will be exported, including those not shown on the first page.
![CSV export button](img/csv_export_button.png)
You will be asked to confirm the number of issues and email address for the export, after which the email will begin being prepared.
![CSV export modal dialog](img/csv_export_modal.png)
## Sorting
Exported issues are always sorted by `Issue ID`.
## Format
> **Time Estimate** and **Time Spent** columns were [introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/2627) in GitLab Starter 10.0.
>
> **Weight** and **Locked** columns were [introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5300) in GitLab Starter 10.8.
Data will be encoded with a comma as the column delimiter, with `"` used to quote fields if needed, and newlines to separate rows. The first row will be the headers, which are listed in the following table along with a description of the values:
| Column | Description |
|---------|-------------|
| Issue ID | Issue `iid` |
| URL | A link to the issue on GitLab |
| Title | Issue `title` |
| State | `Open` or `Closed` |
| Description | Issue `description` |
| Author | Full name of the issue author |
| Author Username | Username of the author, with the `@` symbol omitted |
| Assignee | Full name of the issue assignee |
| Assignee Username | Username of the author, with the `@` symbol omitted |
| Confidential | `Yes` or `No` |
| Locked | `Yes` or `No` |
| Due Date | Formated as `YYYY-MM-DD` |
| Created At (UTC) | Formated as `YYYY-MM-DD HH:MM:SS` |
| Updated At (UTC) | Formated as `YYYY-MM-DD HH:MM:SS` |
| Milestone | Title of the issue milestone |
| Weight | Issue weight |
| Labels | Title of any labels joined with a `,` |
| Time Estimate | [Time estimate](../../../workflow/time_tracking.md#estimates) in seconds |
| Time Spent | [Time spent](../../../workflow/time_tracking.md#time-spent) in seconds |
## Limitations
As the issues will be sent as an email attachment, there is a limit on how much data can be exported. Currently this limit is 20MB to ensure successful delivery across a range of email providers. If this limit is reached we suggest narrowing the search before export, perhaps by exporting open and closed issues separately.
...@@ -50,7 +50,7 @@ where there is shared ownership of an issue. ...@@ -50,7 +50,7 @@ where there is shared ownership of an issue.
In [GitLab Starter](https://about.gitlab.com/pricing/), you can In [GitLab Starter](https://about.gitlab.com/pricing/), you can
assign multiple people to an issue. assign multiple people to an issue.
Learn more in the [Multiple Assignees documentation](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html). Learn more in the [Multiple Assignees documentation](multiple_assignees_for_issues.md).
#### 4. Milestone #### 4. Milestone
...@@ -90,7 +90,7 @@ If a label doesn't exist yet, you can click **Edit**, and it opens a dropdown me ...@@ -90,7 +90,7 @@ If a label doesn't exist yet, you can click **Edit**, and it opens a dropdown me
- Assign a weight. Larger values are used to indicate more effort is required to complete the issue. Only positive values or zero are allowed. - Assign a weight. Larger values are used to indicate more effort is required to complete the issue. Only positive values or zero are allowed.
Learn more in the [Issue Weight documentation](../../../workflow/issue_weight.md). Learn more in the [Issue Weight documentation](https://docs.gitlab.com/ee/workflow/issue_weight.html).
#### 9. Participants #### 9. Participants
...@@ -103,7 +103,7 @@ Learn more in the [Issue Weight documentation](../../../workflow/issue_weight.md ...@@ -103,7 +103,7 @@ Learn more in the [Issue Weight documentation](../../../workflow/issue_weight.md
- Unsubscribe: if you are receiving notifications on that issue but no - Unsubscribe: if you are receiving notifications on that issue but no
longer want to receive them, unsubscribe from it. longer want to receive them, unsubscribe from it.
Read more in the [notifications documentation](../../../workflow/notifications.md#issue--epics--merge-request-events). Read more in the [notifications documentation](https://docs.gitlab.com/ee/workflow/notifications.html#issue--epics--merge-request-events).
#### 11. Reference #### 11. Reference
......
# Multiple Assignees for Issues **[STARTER]**
> **Note:**
[Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/1904)
in [GitLab Starter 9.2](https://about.gitlab.com/2017/05/22/gitlab-9-2-released/#multiple-assignees-for-issues).
## Overview
In large teams, where there is shared ownership of an issue, it can be difficult
to track who is working on it, who already completed their contributions, who
didn't even start yet.
In [GitLab Enterprise Edition](https://about.gitlab.com/pricing/),
you can also select multiple assignees to an issue, making it easier to
track, and making clearer who is accountable for it.
![multiple assignees for issues](img/multiple_assignees_for_issues.png)
## Use cases
Consider a team formed by frontend developers, backend developers,
UX designers, QA testers, and a product manager working together to bring an idea to
market.
Multiple Assignees for Issues makes collaboration smother,
and allows shared responsibilities to be clearly displayed.
All assignees are shown across your team's workflows and receive notifications (as they
would as single assignees), simplifying communication and ownership.
Once an assignee had their work completed, they would remove themselves as assignees, making
it clear that their role is complete.
## How it works
From an opened issue, expand the right sidebar, locate the assignees entry,
and click on **Edit**. From the dropdown menu, select as many users as you want
to assign the issue to.
![adding multiple assignees](img/multiple_assignees.gif)
An assignee can be easily removed by deselecting them from the same dropdown menu.
# Related issues **[STARTER]**
> [Introduced][ee-1797] in [GitLab Starter][ee] 9.4.
Related issues are a bi-directional relationship between any two issues
and appear in a block below the issue description. Issues can be across groups
and projects.
The relationship only shows up in the UI if the user can see both issues.
## Adding a related issue
You can relate one issue to another by clicking the related issues "+" button
in the header of the related issue block. Then, input the issue reference number
or paste in the full URL of the issue.
Issues of the same project can be specified just by the reference number.
Issues from a different project require additional information like the
group and the project name. For example:
- same project: `#44`
- same group: `project#44 `
- different group: `group/project#44`
Valid references will be added to a temporary list that you can review.
When ready, click the green "Add related issues" button to submit.
![Adding a related issue](img/related_issues_add.png)
## Removing a related issue
In the related issues block, click the "x" icon on the right-side of each issue
token that you wish to remove. Due to the bi-directional relationship, it
will no longer appear in either issue.
![Removing a related issue](img/related_issues_remove.png)
Please access our [permissions] page for more information.
Additionally, you are also able to manage related issues through [our API].
[ee]: https://about.gitlab.com/pricing/
[ee-1797]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1797
[permissions]: ../../permissions.md
[Our API]: https://docs.gitlab.com/ee/api/issue_links.html
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment