summaryrefslogtreecommitdiff
path: root/doc/user/project/issues/csv_import.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/project/issues/csv_import.md')
-rw-r--r--doc/user/project/issues/csv_import.md29
1 files changed, 17 insertions, 12 deletions
diff --git a/doc/user/project/issues/csv_import.md b/doc/user/project/issues/csv_import.md
index b0b1cfcfdf7..e1e58e5ab24 100644
--- a/doc/user/project/issues/csv_import.md
+++ b/doc/user/project/issues/csv_import.md
@@ -7,7 +7,8 @@ Issues can be imported to a project by uploading a CSV file with the columns
The user uploading the CSV file will be set as the author of the imported issues.
-> **Note:** A permission level of `Developer` or higher is required to import issues.
+NOTE: **Note:** A permission level of [Developer](../../permissions.md), or higher, is required
+to import issues.
## Prepare for the import
@@ -24,34 +25,38 @@ To import issues:
1. Select the file and click the **Import issues** button.
The file is processed in the background and a notification email is sent
-to you once the import is completed.
+to you once the import is complete.
## CSV file format
-### Header row
+Sample CSV file data:
CSV files must contain a header row where the first column header is `title` and the second is `description`.
If additional columns are present, they will be ignored.
-### Column separator
+### Header row
-The column separator is automatically detected from the header row.
+CSV files must contain a header row beginning with at least two columns, `title` and
+`description`, in that order. If additional columns are present, they will be ignored.
-Supported separator characters are: commas (`,`), semicolons (`;`), and tabs (`\t`).
+### Separators
-### Row separator
+The column separator is automatically detected from the header row. Supported separator
+characters are: commas (`,`), semicolons (`;`), and tabs (`\t`).
-Lines ending in either `CRLF` or `LF` are supported.
+The row separator can be either `CRLF` or `LF`.
### Quote character
-The double-quote (`"`) character is used to quote fields so you can use the column separator within a field. To insert
-a double-quote (`"`) within a quoted field, use two double-quote characters in succession, i.e. `""`.
+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.
+After the header row, succeeding rows must follow the same column order. The issue
+title is required while the description is optional.
### File size