Commit d1154dcd authored by Evan Read's avatar Evan Read

Merge branch 'docs-issues-followup' into 'master'

Docs: Resolve issues with issue docs

Closes #64102

See merge request gitlab-org/gitlab-ce!30337
parents 523f69ee 34b2ad37
...@@ -29,42 +29,22 @@ to you once the import is complete. ...@@ -29,42 +29,22 @@ to you once the import is complete.
## CSV file format ## CSV file format
Sample CSV file data: When importing issues from a CSV file, it must be formatted in a certain way:
CSV files must contain a header row where the first column header is `title` and the second is `description`. - **header row:** CSV files must contain a header row where the first column header
If additional columns are present, they will be ignored. is `title` and the second is `description`. If additional columns are present, they
will be ignored.
### Header row - **separators:** The column separator is automatically detected from the header row.
Supported separator characters are: commas (`,`), semicolons (`;`), and tabs (`\t`).
CSV files must contain a header row beginning with at least two columns, `title` and The row separator can be either `CRLF` or `LF`.
`description`, in that order. If additional columns are present, they will be ignored. - **double-quote character:** The double-quote (`"`) character is used to quote fields,
enabling the use of the column separator within a field (see the third line in the
### Separators sample CSV data below). To insert a double-quote (`"`) within a quoted
field, use two double-quote characters in succession, i.e. `""`.
The column separator is automatically detected from the header row. Supported separator - **data rows:** After the header row, succeeding rows must follow the same column
characters are: commas (`,`), semicolons (`;`), and tabs (`\t`). order. The issue title is required while the description is optional.
The row separator can be either `CRLF` or `LF`. Sample CSV data:
### Quote character
The double-quote (`"`) character is used to quote fields, enabling the use of the column
separator within a field (see the third line in the [sample CSV](#csv-file-format)).
To insert a double-quote (`"`) within a quoted field, use two double-quote characters
in succession, i.e. `""`.
### Data rows
After the header row, succeeding rows must follow the same column order. The issue
title is required while the description is optional.
### File size
The limit depends on the configuration value of Max Attachment Size for the GitLab instance.
For GitLab.com, it is set to 10 MB.
## Sample data
```csv ```csv
title,description title,description
...@@ -72,3 +52,9 @@ My Issue Title,My Issue Description ...@@ -72,3 +52,9 @@ My Issue Title,My Issue Description
Another Title,"A description, with a comma" Another Title,"A description, with a comma"
"One More Title","One More Description" "One More Title","One More Description"
``` ```
### File size
The limit depends on the configuration value of Max Attachment Size for the GitLab instance.
For GitLab.com, it is set to 10 MB.
...@@ -39,10 +39,10 @@ Due dates also appear in your [todos list](../../../workflow/todos.md). ...@@ -39,10 +39,10 @@ Due dates also appear in your [todos list](../../../workflow/todos.md).
The day before an open issue is due, an email will be sent to all participants The day before an open issue is due, an email will be sent to all participants
of the issue. Like the due date, the "day before the due date" is determined by the of the issue. Like the due date, the "day before the due date" is determined by the
server's timezone, ignoring the participants' timezones. server's timezone.
Issues with due dates can also be exported as an iCalendar feed. The URL of the Issues with due dates can also be exported as an iCalendar feed. The URL of the
feed can be added to many calendar applications. The feed is accessible by clicking feed can be added to calendar applications. The feed is accessible by clicking
on the **Subscribe to calendar** button on the following pages: on the **Subscribe to calendar** button on the following pages:
- on the **Assigned Issues** page that is linked on the right-hand side of the GitLab header - on the **Assigned Issues** page that is linked on the right-hand side of the GitLab header
......
...@@ -144,7 +144,7 @@ message in the Activity stream about the reference, with a link to the other iss ...@@ -144,7 +144,7 @@ message in the Activity stream about the reference, with a link to the other iss
To prevent duplication of issues for the same topic, GitLab searches for similar issues To prevent duplication of issues for the same topic, GitLab searches for similar issues
when new issues are being created. when new issues are being created.
When typing in the title in the new issue form, GitLab searches titles and descriptions When typing in the title in the **New Issue** page, GitLab searches titles and descriptions
across all issues the user has access to in the current project. Up 5 similar issues, across all issues the user has access to in the current project. Up 5 similar issues,
sorted by most recently updated, are displayed below the title box. Note that this feature sorted by most recently updated, are displayed below the title box. Note that this feature
requires [GraphQL](../../../api/graphql/index.md) to be enabled. requires [GraphQL](../../../api/graphql/index.md) to be enabled.
......
...@@ -111,6 +111,27 @@ The "Move issue" button is at the bottom of the right-sidebar when viewing the i ...@@ -111,6 +111,27 @@ The "Move issue" button is at the bottom of the right-sidebar when viewing the i
![move issue - button](img/sidebar_move_issue.png) ![move issue - button](img/sidebar_move_issue.png)
### Moving Issues in Bulk
If you have advanced technical skills you can also bulk move all the issues from one project to another in the rails console. The below script will move all the issues from one project to another that are not in status **closed**.
To access rails console run `sudo gitlab-rails console` on the GitLab server and run the below script. Please be sure to change **project**, **admin_user** and **target_project** to your values. We do also recommend [creating a backup](https://docs.gitlab.com/ee/raketasks/backup_restore.html#creating-a-backup-of-the-gitlab-system) before attempting any changes in the console.
```ruby
project = Project.find_by_full_path('full path of the project where issues are moved from')
issues = project.issues
admin_user = User.find_by_username('username of admin user') # make sure user has permissions to move the issues
target_project = Project.find_by_full_path('full path of target project where issues moved to')
issues.each do |issue|
if issue.state != "closed" && issue.moved_to.nil?
Issues::MoveService.new(project, admin_user).execute(issue, target_project)
else
puts "issue with id: #{issue.id} and title: #{issue.title} was not moved"
end
end; nil
```
## Closing Issues ## Closing Issues
When you decide that an issue is resolved, or no longer needed, you can close the issue When you decide that an issue is resolved, or no longer needed, you can close the issue
...@@ -190,7 +211,7 @@ when used from the command line with `git commit -m`. ...@@ -190,7 +211,7 @@ when used from the command line with `git commit -m`.
#### Customizing the issue closing pattern **[CORE ONLY]** #### Customizing the issue closing pattern **[CORE ONLY]**
In order to change the default issue closing pattern, you must edit the In order to change the default issue closing pattern, GitLab administrators must edit the
[`gitlab.rb` or `gitlab.yml` file](../../../administration/issue_closing_pattern.md) [`gitlab.rb` or `gitlab.yml` file](../../../administration/issue_closing_pattern.md)
of your installation. of your installation.
......
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