From 34b2ad373bc8a4b3e8ce138c1cdb56241acd840c Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Thu, 4 Jul 2019 06:24:39 +0000 Subject: Resolve proclems with issues documentation Change csv import section to bullet list, add back missing bulk import section, and resolve minor issues raised in https://gitlab.com/gitlab-org/gitlab-ce/issues/64102 --- doc/user/project/issues/csv_import.md | 58 +++++++++++++---------------------- 1 file changed, 22 insertions(+), 36 deletions(-) (limited to 'doc/user/project/issues/csv_import.md') diff --git a/doc/user/project/issues/csv_import.md b/doc/user/project/issues/csv_import.md index e1e58e5ab24..cc0d5ac9028 100644 --- a/doc/user/project/issues/csv_import.md +++ b/doc/user/project/issues/csv_import.md @@ -29,42 +29,22 @@ to you once the import is complete. ## CSV file format -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. - -### 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. - -### Separators - -The column separator is automatically detected from the header row. Supported separator -characters are: commas (`,`), semicolons (`;`), and tabs (`\t`). - -The row separator can be either `CRLF` or `LF`. - -### 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 +When importing issues from a CSV file, it must be formatted in a certain way: + +- **header row:** 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. +- **separators:** The column separator is automatically detected from the header row. + Supported separator characters are: commas (`,`), semicolons (`;`), and tabs (`\t`). + The row separator can be either `CRLF` or `LF`. +- **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 + sample CSV data below). 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. + +Sample CSV data: ```csv title,description @@ -72,3 +52,9 @@ My Issue Title,My Issue Description Another Title,"A description, with a comma" "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. -- cgit v1.2.3