From d19f2c28f7797d8fb37aaebd4378d08d1296a2ad Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Tue, 22 Jan 2019 16:37:12 +0000 Subject: [PATCH] Edits to issues CSV import docs --- doc/user/project/issues/csv_import.md | 26 +++++++++++++++--- .../project/issues/img/import_csv_button.png | Bin 4342 -> 0 bytes doc/user/project/issues/index.md | 16 +++++------ 3 files changed, 30 insertions(+), 12 deletions(-) delete mode 100644 doc/user/project/issues/img/import_csv_button.png diff --git a/doc/user/project/issues/csv_import.md b/doc/user/project/issues/csv_import.md index 001e0d303e9..032e3a73ad0 100644 --- a/doc/user/project/issues/csv_import.md +++ b/doc/user/project/issues/csv_import.md @@ -2,16 +2,30 @@ > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/23532) in GitLab 11.7. -Issues can be imported by uploading a CSV file. The file will be processed in the background and a notification email -will be sent to you once the import is completed. +Issues can be imported to a project by uploading a CSV file. Supported fields are +`title` and `description`. + +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. +To import issues: + +1. Ensure your CSV file meets the [file format](#csv-file-format) requirements. +1. Navigate to a project's Issues list page. +1. If existing issues are present, click the import icon at the top right, next to the **Edit issues** button. +1. For a project without any issues, click the button labeled **Import CSV** in the middle of the page. +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. + ## CSV File Format ### Header row -CSV files must contain a header row with at least two columns: `title` and `description`, in that order. +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. ### Column separator @@ -33,7 +47,11 @@ a double-quote (`"`) within a quoted field, use two double-quote characters in s After the header row, succeeding rows must follow the same column order. The issue title is required while the description is optional. -The user uploading the CSV file will be set as the author of the imported issues. +### 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 diff --git a/doc/user/project/issues/img/import_csv_button.png b/doc/user/project/issues/img/import_csv_button.png deleted file mode 100644 index ab100a9575087d5808d47e14b12e511423e45544..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4342 zcmbVQX*d*Y+vcINrKzT|Rz{`CUdb9UM#fIr2~SjLgfW9`iJ8d~M)t8}m@t$jTgW3XJ;K9vSP9)L;^E-<>yNpyr5=mD&StZBcXvgLtwcmb=I7_v*49>5R%Vul zK?!gW2$YbLASWj`H#g_w<8#QZW3mnoI>-@z8|>kH1{>e8psA?|27?K7rt919EOzg; zYf8<{&Fsm9Y%~gWD0E9gfGKUUnU@nM@{|y}&vcW37H1 z8m> z(UQOyVQA5k$9J@^tI5lUQ}_EfSRJhOsGJY%G%g~4EqGDZdl2db*7uE8J2mY#Zw|Hm$?C0+G z_VzM+UAlWq{)SsugsF$pP3tLU*VrO!cN$YQwzf5tQPIg_)O3); zJv=-_i=7pe?cnnI5|mGSTOY(eR#~C)D>Cstd7)ahPY?)1MZ2?^nVE31(MLb+P^j|a z4twJF(DK~prv;x;(ZyskdGl-DCN0&hC26uTE+gDePxWfq&d!H9W>DRNL*8V|=ojs< z&KGZ5{bDM=O~230%|-g>h`vu3Eyekuf@Vk1LwShoW@oh$E0MyxMltmIp5AB0jg;yS zYTi{Hjm349#O3KoqOWyc7d5S+i&#~YnUqxZI^vqKe`vLpy}m~7SGL<2y|lJtWvG32 zk`kFlrq8{;?GC_AYa;F;?&rO^kGcB*?UEJ&Ro(c|g{G^rT z*T0auJOj-*C!hS!kTb;VQMJ;VUoA+Zj+Ji4ZwG(u_{FqFOW)V?^-xv4*{wDb4!?7m zG*C?YX5sOUtLlCA<6#2KqVuFjj1^?Z;*7)Gb9sJ)z6XZM>fmbW*2h}fG7ft@CbNNa zrSW%8Sxul{aG9@10}NI$Bb~!<(_Do_6Omw`!bOq@%w`1VHE5u zNk$Rw4%6j~`id=M9?HH8S0E7Mft$wADK25xvl4$Q%_kSH$-`bvT5P*LO1CH)%Tjo_ zjH-9MI_=mi0c>w2JU#V_>5S!DV7LWj>E!5#Aq9@Hb&Brab3V!!M-g_=!ewBP9S4kS zJTp*;awy>ZniPmo!>#MTXinsoNcIjK`XITc77&_$xT%WO#(Ii05DTSp^#3iUNJ?_kDqZcUz#er1St4T*b{0bPn7=y$ zQ8ID7kiM+nW9WAjR2=N8wrC@L#(tp% z{8haloPUQ5V48jn?HZZ&EX`KDbW35hBub%pn?nq#&; zDhdmT88c*K@wEE6%RDBlV<%32yS=e&!|43kTSCSIc9lHsg~+)E8212COt}7U-vzMk zto)2v0fUb-k>bb&z40)xpDN3kO8u%Zl=xKvwvb^^nqTOch+X;m>ZtlB2_RpQOG>5D zMSKlK=00&sdveGeOJ4<@XgKx1O6XCK^<1_BdRc6{8Zogn{4PL z9S2Xq+(!rzj5jT$Q8QM$B<0)15@^klad-n=`Gs+Cr&o2uS1Hg6aF3o50+yW@Ak=&~ z<&cxyO<%B0dE6VSx3sM(gm`P9hpshU5L)HWN4m>vzI$20%WL9R8&^|H(cutes6l@t z`At4`#*x|_M#>le%oPo40=3fU355d}ZiCAxJ-5{6*`eS5>2IBXF}jix#&T@?OLADH z6Lyx;Y-i^B-~i3%^}tJEq1kkY(sXuCnLqMxakjW-cyj*(OzXLplHaJc5&7~B4m%lD z%wiT;U%8maC zC-iu^Tiy=;jh4LVhYCX+JyL`Qb1vDeE;Lcw@8!v_oSBc}`FH+uy%eI{BQC`E>-WR3 zv-?7-XPpy-PApg{R3X)0j(R#J;=lhZzdNfArhXc`^wD3o(opU<{;Lh(=n^yAM!V(m|{!W6( zyJx*L1wuEcY4Bp7zs`UB`mHgU|9cOQwnZO1df2aiv)VpsQ=uNPu4%)+{~g-*>_}&| zJy_r;v@88ggAPS7V4MHc%3d|T^GQ-C4v>f+hkm{QJ{1&;fk$DoqA`v_vlsY$PZ4rG zVZ@b`#_JC~gk$m)Rm>ZJIu<%Hs!^(tS!08jhz02~3r1fO44~#3VA>ARIgQHC%)B+C(r;qxj8sg^= zYCbrdbQ3@UAa9y~QnVCbH760LMWFWj+-`u}AD;)zk+>~=W~@n?9Fn^qIEx zw0wSAp^Qd*J*TV`Y+Y+7U!u{U*=n2K1Xg*6P>ipNFOL>KaWxm!`y3f$Du8|1FK0s{ zPT@=o$`Ds80|`9}*k!TxAcx?xpQBZRFr-AMF3eng@gk$`)-`l%zlsM0NA!Hdt(znX zp9Xk*^$#W<%F&_ASxIEoGSo=YKb!qngR$s1+_j8`1*9@Fh1`Pu5irxoo2 zG7xL`>FP9C{0n#?s`nS$9HAS6ECz}W3Lf`(fveKh9V3F7G`zn%TtkVJT?94@<1j0{ z7(Gs-Y3HmN{t3RRm|J*JGw(kT&WaB99SdGOLAWj6@oU-^085T=Bb&Okv75qj`)>he^kyK^!w;?TXzBc|8Jm8OZo?7SHrw(J@;EG z)8kBsy8xgXE>N82bMm%IzSq?TZ5;labFB~cNWnK%ZjDT_zeL(}wrOpns=Ima(I1^$ z5w{3Zx~hsI>as#8wcKcdnHJS~dAY+jXlK94Oc5W>ojODL)1CKZyus>$U9Jh|*_;+8 zm+SQF&@O3y6|Zqsi}Ut!sqTavTMNICMw@*0?mh(%{_($n*fbLQS~Pdb4v|O%U*8)1 zq_p4Z9cIT+{n6h|16(x{7C~#>+ju5(2|6z-vXV3-hD>`hYt?OlJCJp3#RLqVPOmo1 z@cq;_oV6kC?)pgWu{$T#`g=^A*Rh8tdRkNdRVp@lC6=1cvyu%mBz51R11%1;Pq6^*b=X1%|y&!*8 z>~;itQ?s95o;1Ai3Pq4Kt25K2F(WAfJ@k(m0>|ATh-o{%F-u;m)VEhCT_awZ@>dIb zCNxjTyAvABJYB0eMg4_0jb#EfE@JnPF)qxzXq!Z=V8n%FFmMqGXL4I&>vL~VYC=5~ z-J&pB6&E$z8bEN|QCKs4A9*{(G#y&Zo$i6)E^s^@hV=_P5}3$&x)pR?Y&Nn7$Q!tR z`N*e@7WjMk-6s;s8vgs*by;yT6^v}lpN#K1%BOdsG=;*JC_QPIS%3&X5SQ5I>Q=RWZB?-}cR7kD+?+Ab0mJ?->7 z$F@RrJ=V((u?p;>C2Xyx^Jz=qB3z8H$HXN-tu%@7CzM{>ku<5^GEk5c@1AdVla}ih z%R=*PD4K8heukE7jBe6xQ{1#|X-ij=2*e;4%2}pSamhOWNaf9+6 zmIH2N{rea^w#d00VD$)G+y}Lc!WO9?vInq5Vjbl%$1b}e55FWhI1KbmVWm))h<^Z< CNv7!l diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index 40a1f60c4ab..5a3ac9c175b 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -144,12 +144,12 @@ create various boards per project with [Multiple Issue Boards](https://docs.gitl ### Import Issues from CSV -From the project-level issues list, you can find the import button near the "Edit issues" button in the upper-right -side. +You can import a CSV file containing issue titles and descriptions to create +a batch of issues simultaneously. -![Import CSV button](img/import_csv_button.png) +When you navigate to the Issues list page, an import button is displayed. -Learn more about [importing issues from CSV](csv_import.md) +For further details, see [Importing issues from CSV](csv_import.md) ### External Issue Tracker @@ -157,14 +157,14 @@ Alternatively to GitLab's built-in Issue Tracker, you can also use an [external tracker](../../../integration/external-issue-tracker.md) such as Jira, Redmine, or Bugzilla. -### Issue's API +### Issue API -Read through the [API documentation](../../../api/issues.md). +See the [API documentation](../../../api/issues.md). ### Bulk editing issues -Find out about [bulk editing issues](../../project/bulk_editing.md). +See the [bulk editing issues](../../project/bulk_editing.md) page. ### Similar issues -Find out about [similar issues](similar_issues.md). +See the [similar issues](similar_issues.md) page.