From 6184fccc1d750fda60eb8bc4fe3b3c368253b68a Mon Sep 17 00:00:00 2001 From: Andrea Visnyei Date: Fri, 7 Aug 2020 12:55:28 +0200 Subject: [PATCH] Adding environment setup chapter Added info on git/gerrit setup to doc guide. Issue-ID: DOC-654 Change-Id: Ia9ca52b0277a18bb8934f15d1a5ec89a1f88cc9e Signed-off-by: Andrea Visnyei --- .../onap-developer/how-to-use-docs/CLA_types.png | Bin 0 -> 25736 bytes .../onap-developer/how-to-use-docs/index.rst | 3 +- .../how-to-use-docs/setting-up-environment.rst | 150 +++++++++++++++++++++ 3 files changed, 152 insertions(+), 1 deletion(-) create mode 100644 docs/guides/onap-developer/how-to-use-docs/CLA_types.png create mode 100644 docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst diff --git a/docs/guides/onap-developer/how-to-use-docs/CLA_types.png b/docs/guides/onap-developer/how-to-use-docs/CLA_types.png new file mode 100644 index 0000000000000000000000000000000000000000..d687135af2dfcda8eea4587efcc8229369ff7377 GIT binary patch literal 25736 zcmdSBWmuH!7e1;;2uLekN{MtxhoI7>NDf^i9YfCm0@4lAEm9&NHFU?&-8I0_4MXQ2 z_ulTG`<&~1J0H&Z!o~H>ywAJVdY|W6Yu)$#PLPU{G!7Oy*1dc8aAalPyuWu3<>2oB zi-+iUf1ewWV&A(*dr$U_#0S^=+jE#YYECz|2O6f4M1oxk>@n3DUxG6kjpZy%Xfv5f zt5(#%nVYj$^Oo*iA^X}Wp>##FW~1ZG zY2pEgwZcSCQ})i;2lh@E)>1A-*YsjiQ&YqA2qQnC($n6@lzD|h82KuepbFYO`r%3J zAA_GzSy8Z-UgH1zt-H@u+EE|3X_VlqIx+md_HHzTR?qm?H2+?#rtnGv@??usP2*G!QSGThAllF{d`{)``Y~adv zho{(8CPuB!xz8JdM;mp%Cqm=w5N}`t`R0Ogli%SxD=j&azeD+4Gh@lubKH$tghNmpw6TQwp6|`RW(1h*dXeh|Zw^Q(3M-V=1Am^2 zHo={JVQJjEVXmIanicM+*)d&o0Y;U2f1$23H=ScWCl_u1)wr&dFeofvENgcBy9F{1 zR6-lcB0%{)%$NMxUyCRfkl}!K(9}M;=4vkQ^w5rbibgQ{oxGx^qzehZwi88HdEmom z&vLj*0oWE4#&laKm^>If^;nhFhWjWdl)_zHBkocfA0FxFNAU1$eRUQb;|%$>9wE3> zE*0|c!ph)9iDeHA2x$}Jk7&cH=hY=|ksMAU=J8l0U?tJl)#kA|*06HhBa`y;BOvAr z2F}aV+Dj;JYCAW|Y!}E+0c6y*b=%Pt0F!ou)9555BwLc*#L%Py*V+#rfA51&s4o;U z2+4{r-F^g}k^oA$+`0E*nDg~_XaT~*i zhq>9Z#CwoBFGNe%C1yN#Tp77eJ>A3^iahbaq2taiD2(MUeaWBwn-OGFN;p@o@FO z<43mOTT<+(zE_Aso$kgBogFAyXFfW#F_%Rye5H%KcIakX((~&9P7;uXr(5ge72_U} zsWyq;S6X?(%f{%Xbz;s-WMAG=7l|*Qic|{dT<#5L2;CULw4J#+iknYe=V6Ri3`o`4 zCU>Uk5hcyv4t0q6bXvj<`piZO=ai(r% zJ2=5+a)6Qb9HhFLVaRtJW%{;{J&^a(oYs^Pm2(ZH0Iw;8aP3O`9E0CfW@htyUh6;Y z&p$jl5)AN7^m{sfNm^u*r1g|-(BhwSEb-xoBH9MnJ#_IS*L~gtua6C)MJZGxPO=OHI|GW-VkBGm)}D)n zT{DkoJc(y_+)T2p6rni*(K5_I`vdeO(%hgk;_eO_m3+Kblac;7JOZb_s$ibevggY- z?#h>uUx-KwRUJaX(qYv{G!0Fy5)U*#)c=mFy)x0)W}=4+hosNQENbo+}Y= zA2VNEueBvUN+awWdbG8?3uo77cgM&r6i&llD)Ey|DcR}C4xyYTZ#MQ|BCy;e%{?-0 zOpx1d18*E?q5|-AoAkndgkn=p*F+v<-YBqseYR>!M^?cZz6@U5?m&&kw)|+pN_7324Ivn>b;K)qt-l!3a#B{vQQnYvsdcko?-$BK zw-;cJ2ZE+?q%+-dPXAk#b>9}|g0Uo zzjnDw7U~NPeEk91*?lJ zKepm<5V$byt(Iy!>8e0%o8!=!aDPWDwL{GPcy@^pT7ZXH7+s#keoGyr!p8O>ZSB}(JPSMKeo_MHVYWzyRy%_`rVEy|0yMbNDws>j}@~Kx@fk7@p z_Mq+Lj<`UQpbC*gj337@ce4WxrWa0TuhOwK{cGqvZv1?E@wXJIj=~eVF=&x|O|Rkq#>bcz>q_?_i=lHT$DnDaTW(s9DEs==M?zB>M@%$Fb!oOg?BLZpi>~XvK+nM6GHm zBqT>wP{REBVzehdBjE`+{?OtFn*tINjmM|dAw~gPOS>mDzV~_^U?zX>>Y}?IRe3Lg zcsm!((7Nngj1$G!!ug`%b;3Surcg|A?vwAy2fM;#VZ~&=zW8)gKY7bE zoeKXhFMj72b3Mo|JckM3D`_)~M~3ZMopM?O#3K(Gzg(p><=gRZ0w@+gvP{%0&X+TX ztA8tGaERKu`79)wP-cjkdGd4#q5Ns>qfZWfWSY}w2HOr!tM*S<*MLeUBwwA<`l@?l~T$TH_NWSMUKY*^ z8>@_b&sKo_z4%=B##~gzZsUY78BP%z+l)~R-d&87-Zfq=Vl9pSdVY3vPm0&O_so=4 zuEY~L{2YRo-n(BhHin&EdM( zr**D1y0}SUU(RVWFJ*(zre8|;A~CNDeZL;Tsz7fy2aV^=avd^Uu6cJopLGxOGh>97 zAsMU2Y~^-a7qw?+liyD+F6j8g{Zp>4u&GoRwE?u@kqf|E3A~=zL)Q0t$*lozl_~}L z`gcxh(XTfs%tHFNqj7v6uA5v&I^5f8chsnHh8Fft!}#?9mC4aA28m~b;}|qOrd@N8 zG?V)GNhf{x0S5D*lw2yHYo2QJRLA#faIjra_s3gw%xT0zZJ^Nuo;4w}L_R+#L_|R- zu07-f{<9V{0qHyrb94s!y4$t4oh(=jVG!gPY%E?3Z%VnpmwwMFt>%N3qFgL3vTQ&G z+L6iokYe@W!cHRZBPyu`>tK2HVO;0OcJ{NNbwu`~1@Cg}wi#@`oZ-oV3L)p*+#Mr` zx)G~eI$vU9v}ACh1KRjR8N=~TEXQ(v#zoqE^_&ACQ0Lw09)%h9!VVcP{qwa~&4d#u z=?n~$N|GXOc@d(YDt8c@@~6~%RYxAATrTq(*Nrb7QTOAlcMJEOAv|M#w9@x%=SIph zjlVeDT%iG+H5@{PC%%cXiGpr*?X1r#DO>N#2V3ft(~;7@TaAoEtPeFT2gKj~GeyKr ziDY?PqGBsT+&JEhc*uTy8jK-e5aC+7lrY)t8|3#5l_xj!RV&48tz&b5?l(K!k*JXc zY;a6r?& z?gmX652|GO3Om}hS5Iw>SVXYIRX72-j|EI_FEFY>j^*7@RSxyeH?9pB zH>Q2mS35kl%y-i5Qe`ncK&h~ZH4{=eIDeAX(wln#wGG@~&P+S$*&i2WRkg4Z&b69K z;<xb zs(2a}s)gQhb#X)lvF&}_RXvzw8BvdY!O6AB)KjCRT6yUHb0>U8C;uq38*@8sl@9z! ze^zbVmxiF;g%@ph+AcO}?$bVAbmF^h?k2!S=vXs((DbM?0CIGA z*N1R=UaFq5J05VIyetFB)>*UHGwtlM%05QO=Yn^dU9kXI*J?C8m(EnrUcQVS9ktq= zH=4`U3Q4J6!f0S#n6Mmauuu6gSjQZOZEKW0ZzL2uqUGg$SyoY0VPWq%a+3lQ`ZX zQXcpf%R6SwHd}`mf5EleFF>&&?$qcW)3jfKosH#%9e(+{Fa3b--A&bokh{!HW14j) zGH5o~*>G+YZI+0uk3x#LN?(kozUjY?GpD0Q#nV+{|IOdvV9_A@FvVLQeos75lirIDXwC9$^wUtK4l5cO|8ljumWpy=4-3DHo89GsW zyEWsG_5ySR|F*hW_MsQnPof_K=RnM2O%&-KR9vfUR_C1t^@Fk;EsieVOr^;!FS*d1 zUJsG+Cmys-^0dYL)EbAqCXWd0J+__p4fhlydE$#OkI@wtw$Wk#*#M`sb7!?UpgeiJ zQ#-f!d~czY|4Xw`5gA>s|jTqa7*+G(Zj!gee!*)PLNoZJ`Ico*wsrS(N*?Rzzf zK(@JrN@H9$`(U4H1R+`Z{zI*eTGyw`dVD9~FA~{Vy7>l1wa<-CiLZ@OU0nsg+)@|53sKJHkG4)Q0k@F1g*t`a~OrhmojCm2)2!x|o8pylV5uAv>*Re+)6ji`holGPOGhN`aaG2HJ`F}LOvEEwr=G^qKuRl_CekYE z-LAsckfQ8d8cETfAK_t_6!q*B@U)Q@g+Plw4npyX#=GTb2 z9fuJpT@QcGjKDLn@7C_YBiEfRdz>Y7qA^$F)K#N7s7$3*Jl1E16(ZPq?L+C!rcJ*aU+32isfii>}P0bPY9bR65WTr zGH9YOVmhCNv`vx@`-A~UYnQ}V6sd0+Q?jM@tqO|k$=RK@-mfjaoynrvv6Mfwq0$h~ zneyD<7`FeaPbKZR`v7e(Q+aUa=4G@cn2{Cii^KzX?RV+L*EvgM`3rfzDx`nO?3BbJ z)*-J;7-!2mFJxH#(SXJ)4Po@SEk5l%_%HOcN$qjo@`(918^2Ey2`2Qm`>RLANUh~1 z0i+y6R2;r7mF#X4E;v}R#RmiK7g$|z`(vVA$-KLC7SrUQu34CQxu;k#@3?IN#^swY zw_KxK6n>(&ZuA;O|NQeZPBC{WfMThTm*x%oJldXX|m6o`iws(9d+I$vQn+w zo#^LMDD!mVSH*nYoJQi?6wYc_q$4QFUOrlmRVH)=TEKOThb;JGT?m~^Y0K?zxVAep ztcZ(_NI9G~sF+F}^`2Whpc6WQ(BJ2mjo|*Xs|udlDLOklpNw^Cy2-sl(U3Lhd7~}% z#Il}1`07D)h*xi~+V{ZH-vD;TSJdyFv1h?c@2Uy&XuW%{-zcT%HsNIDzpQ2so?gV zM$hJ@wscth-wAy5<9)P)mo=ATuD|a}PwV~tc?Jcbz^FLC|L;)!g~z_szJuVyc0FI} z{SSiAc!BjiusFCrN9eZ=cOd@%)0DIgFHVv+S^r@O?ryJ=b!YFy`mP4z5A6T@*H1oY z-zP1%dBJyN!vD97%;S@QY-{3)h@b@Vj;-H(_|q?o zPp=prF7XJ|d1848xs43BK5PRl?M$R64#7Hq+^5Q5{Jm^`(I6S+C{HNcfYAaY>4WA& zkkeb6ELE9@PoJiK+&9LeQNn!6>)_RnewZVJ5=InKQj+bYc2U5p^3_()2)4AiD3Q^S zR^45nx&1q=&uzW2aF>XtN^elK99I+1*y{Mb#E@%^(vnN^j-alk&gfHFR$GEtCU5Z< zk%^r=R3iK9oKbA%Uc5Xz9REJAL+lTB`01*dx7Vw@ZaIdeNFr$2bxe>Wv{-4bE1Ii* z-^M)MfkkFpK8{Qi6Ddr+^EcH*Z zxhT{^lQowiV0l3gp#{@)+)>L%^3FNa__QjeO$Slz_cLaoO+!*WIFL&*$kc3G_3t_&igv~^H6a~UixArXy8=| zAM~(x(pu=qu=}FbWD@X%?4voXQzIUK7szw6DS38yoiat1Xq&29!CbSg*+CxeJy6EY zO=)?~cCh=>?_<^hlut2~=Y^4(p^OCl%Vck15GTi@lBDfad49UR2KgV?7A8?-J(|V} z70GfCM$O`VJVqnaArCbZ3LQ)P)?@Z6ojw1puyE=zpMMwia~|(4v%aL41-%X|PEv|_ zUTzp%`ny1wG>fdvIUbo!MRlQ`u}$@gnN7p_z-W;vs&-c|4pmo+@09Bt$*Wvp3j4YI zfk0iVf$TiFNix#gW4=6_tIg=8^Tnsf> zW0Q~fkI1Of8~UyyS8UlxIX$^EscvAEGfP1;kZ5!~jFFrZw-d-ue~uBQNQZs&>A6dn zUB|{Y7irw+DqYq`@wv`^xDfJVJfM)# zLwf(_0B&!)r~E1aaPGFIP1t{fx4-OtAZqUBiAVF}Ji44n|Dau&{VF>R!zDoE4F!mc zuj0Md<(aR-%n{u&8y}nfz*(^Jc;Vu{{%g#Gh9D$Z%%CscJmsQ8VXhJ00|$&U?tDvZ zmF0qzJBd$}Z#0Xt?QBJ#7b3GX3v_j+;Do1ABCEVaU@wc_`i33z_gipE(b9<2TZ^_< zL#mInEdh->lO4@SoQEkFlvy?4k(!d)n5E;Y`C*jwMjeBhW+d;!lx|Q~4T5UWe`{%c ze)xY{wV%*B+424h34voeFdvYaBoANBXRnQ(Uy$U;V&N82#n z4zc#ILT$wZ3a+>kx*CLGsDAx#YA*7X7Pg7T+1A8%);pfk%efJuTCFm(aW9wI)a$_> zK&kSrMd9pe&xO`_0P78VE;POI%Urcq*|spF74%04nep}v9k^KnfjFJ&xgbk_T?*P8 z7QCB5xHL@HQycm5gsLyev@-Qj7Fw9Fy}d^a3?OwPB{F7PTkzSY?oS8Fxv*YOe2J|0 zyuR2jy!3SVae2j%m0~tEZiQ>cv2HlJvbcSEW361u0ZwZyDbhGe4%pdBfhz-7;L7)EXV-8CRo?q@^&BvKT*_OHY6^szL~uyTkIG?507YX*`)=*=lUl1Z%$E{EZ}eu zFNIP#)a%6%I90fIXtj1qg#Y*nV`^1rw&dyeo<5u%isGy|(`O^LIt^C(Ygh9L{VwT7 zUE2@+>jZqT$)prPjSZrv&`~(Yf&}GM&G^?Q++(XQ_}um-iLG%>U4$du6Q#!5-&z2- zQKItT(mfzp+|x(3$r>7AVJ5w^^H12!K$2;`s=oHb}@WoFZwq)z`~5uy#%Kvtm`i&-+86xJistD9mhpjlM!G1Z>3TXr@YwHm?x*w$F# zwcEu_<0^CBeV2Q;90SwC9;{!tQ>HevdrH6M&%J(l;+6KTs*t|!(w1`fg4xS>dWYGZjehs>l6T zjmfUGtoWC2S4Me&cDAzuYjQQl>CT!if~~i;8~0mKsK9osp~7Jlwb3VYg;fS-@Pc?DMWDhgVz8Y8!wP zPdqyW5lX(qeV@chgrVD)8-HvOHt%4ZrEA!MQzK1j3#C#|Ny8u4M*9#1vgWx^jl78U>N>4Fp|6 zN_Ghcig*g$%lg>tSL|R8>5LjUI zOZL_SJf7ua0d;y2dHCQPNV0(wNKSR%2-E5cgX`-t`fBbQ{BbazxApAeuz9r0c0gn{ zeeW@cz?RWOT*h{tu9i$%MUhJhOj_k*e4-WfG{Grj#K+_!rtT=;z1T* z$GfM6L;ujxzlvrdZ!FI?lh-~Z)@D0M-vj4cZ&5C;wzf9VcI6Ca(giNX>PZXXZPlq! z^QucCxub9+RR|L!qyL$$O_S}WkseJP2TIw)s#EQzRhL{s$4gtvkjmA|J{(U4-7BFu z-MfyaWr1tX>yR@~soZRP!E7{BziQmy%R#hj~LsD^>g+~Wbk+pBrqL=hCxDLb=rE7 zau#HNhg<{!CFiyH{8n>u{_UPJAZRa~g%r=B6-lutf*=~QZi{J9x-F4KOh@LKE+q^t zJ@OUWzTeSFJWJYYJzLkdz(XgD&-sP@X`HEyL{9U;l0%etoK9cGqk5guW+}{X>N5|KjbxDfRBlri>Z14ZY7}qyDXl?{3vC zeb;543lu#5Upsmq^Go8L+uT_nr2Y-)of*$*?mE{M#E&`u!Oyi=!3URkGm^Asky^^!6#E5`3v%uBh#SjPkq`9e?G{&E;Cc2jtgTxK~gn3KFa1UEax$1 zyG#xXDtc!}D0;7f1O!}R0ZDoWBjqaS?4=mX`E5#@J(H#Z_LwO$Z`xR;T$~nr{33>2 zE{KN@*R;>bM~L|}`x$Uc4MRk4TVgCj{`9b0J44d%q)!km8_1TPUuxI095XNIRb(3TNb20d!z2FVx_w4L) z#l6~Vyw$VYv9b)?krJZw*qxx79q-iyCHATngUwo*f_m7JzcjF9rGi9%rEwXIiopz7!%>WtXj z9`7+j%)oqN(`Y`8eHE&>i>Y3v|F<7fA_8nafe$Ym^HKRapD|w;%h}uhP!+9s{->wI z*dNxz3Zy1I?bgtX z#dj#=x=Rb2E?TzEna3l(KW9Ok;^Dw6zQbMs-TEmUMm7%R1G+$(N(;3{aj5%WE8d$K zdFFM)mzbBgmlEud<#xIXA@jl~|IB0efwVyhaO=G7v7}*TSm1`5C7R0j@!g-NsfKJu zi&x3me9;38TmupQdDqZy*Np1MxOH59jJHo*FZH0Oqp7TkRLy{NY6d!NiwW!30~^Kr z5OI##ZCRcO0?|uBVn|9$BZqegz!=h+4jd;s9h$6S9zQF|jr3c-y=GMI=&O#1NZ0LN z*~gPfTcm8Eh$x2mJ4X~}_aiJPU)E>U^Zu{$zl+|&cgzn-v^U=?RLK5q2=0b6k}yB4 zr<_@s<*)vgG5$#&89KkR33eIQf3nHcuWTYLzw)1K;_xe*u=l=r^QZr&Oe%{J30HKA zL3209G*h~l|H0E_ycc$myf zD*fdbUwHR_vgFFIEIFH(iX|5YG`kg~7c3k$G9?N${UJ>omD8=xF_tTYMc;=B-0dGV zN{*}c5?s`++aH`{9hbxWW!ncAZwvA^po5t-{i5f5`O$t;)}88cF>3i*oEx$4o^!PE zDL$&BH3Ziq2j7ErWN59#SahG1V(Uz2QgV9QPCM>MeC!VE4u_HJnGFZ2Uc@$Ek{GIJ$yoj z`z_B>IQMt=Rj#k85%uiXiHU2IWuf)BL{rgmxxJGmuCAdBaQ&|GiqDltv_C(U8K|0M ztdR1DgSNzH;B{2M?o-!+k;fjt$ZC}_)bFPF=}=Q44;lbkL=o-N_BV1ZSk$IZvZSPz z&cuhy1HChO1gGuUw;DJNFN~-_!qh8M%`t&&YLDYP#tUUR~T-#gB|aUQD3AMNeoSZ)^MNo!Kig9aX*6 z&}4Gq;{+0RIGSo!c%ch?toPoq*&j)ranbWtnzlz&p@5pSkpO> zDWpQ2KISJ^st`XtAw>+oWZkr>hQW;+OuE$|&118e6>R!sRkFb8^J|Rc5ugfw*xalg zh>h2fnJ+<0jQ2B8HHpV##TjY~@9#dSEWMmkNz+VT!&_|EOaq%^Gi+p+7XoB!GI7_$ z!?T(igVPX!f^N|{?nB z<8^jvtuMiA)dwdjNyqK?Gj(_on*RvXX**Ej(c+`KSA1bpHFo;UphKK=i5v#7l;;X) zsSD2&^;Afl@;!PTY&S zvFPPU!bxhjM8xjdog7XA0XI7F4db%F{-vyj4b+-?k64EmEZkQfFbn0<;Nv7DVtn>M zl=KSn&HCmChMsPV)}fkzy@AYJB99*v+>y>$%=Mn~0QGAUj!TWDey5+Sz|=$IZ^s5k zl=%Ey6B=9j!k}*3jk%CSdo(ZIhP@`SQXw?_FSR`TRHPDZGBn%uhFt@EZ@*_((kw;^ zgK`>3HKre=1G^M1zff}2glhHJHyyHhSNJI0ojcsGyB!!DIR^%IfQcO@TJd`p*Lx|l z36dPOV2<1k^|))0GTl!v3d2Np{8D@#Gh+YA>rflkLN_IsC$(QHcl%AtdJ0Aq^coK-Y?vl@td9BZGw3h!ZXWW| z#VGSxf4g}tin%L}FFryHU9En!BjO**B?7X_unq+X5l4K=O%%<+)(f{4Jsd5bP+00; zri|%7U!jgcqv7dk6jC_)qBovz(_zoO`r5&4_Q^YSf^ffZJPq;PjYAgUQ~EV~6xMS^ z`hLEgAF%4E-t($n@h2R&aQ|5?uedL--0#EEfGQl2VO4>jaOV0`*HwRb=d^j*bMA0{ zYs1!eUOugom=u};g_s8~myABgd?Ef-_k0O?b&S1qo80VGjmckG=eb+%MH`ASO)=5r zwYcVJ2P)IY8<3s(Do<*ttG)c=xq~@}JxzM9@*aj=HeDtjzcFGuL9)??k7`=_VyExG zars=I`v#kTrI>YhhlY0B`y`I#B;}hREp=rjK0~2juqq104UDb0_mOqwqCBhPH$~!l{pJF;w zSBIIiRF+vyQl)s>5@xAi2XRrn7jPSH13x9v=+KpR0MA9mFy3^(9%{Bdv2%!G|Pu`CEk#tAJbd+c+%pY)D@b60cOiU6^Oj z<;!Nd0crW7pEYwr!`Ua<<4PXWD=rhcDbea6V)Kb=! zuZb&&!t2@>=g*lGw@A&8_R1{Tj7Jh|_|B%XW>1~Dr6Y3o-<|ETk_o12N@t|C#kES* zMSYQ!yOMVlu1+ACuXLJ?dni@E))GUZ7*}$3;!6@pdHyU8q+x6^xd0S&htJT{h{|Cvj+AV$<&!)_{OGLQ?LtEX7 z#?mLdqGobR94@*2=L{bSBQ(#65MdXI(EXYLy^iqmV=c^%}9QO3TX)U_P*b5?_`+ZQjL{4VfET`Z^|jFNgc0 z*2bGASE#I6n^?DelfqvIjf=b3MiHp+^pafOdCNs%Q}#vvqLp^HEze(V?4?i^0HUxIWo#(XS{4k_7^d9e7 zPdmjJeqqi6plVjxCFDpE$2+#kbS!&Gs8xUUFg49HY*Ejq!)2hn;%=oj2(5uPSABCh z>nrgTDQblqy!UAYeeWq72P*;mIc_jS*=-C$O5~R;;%GM7Mv8G@Nv41q$E=lQlc^L5 z)tr%;T;{Mj-E;ZD9ta_Syk}on86E%4d}})6#-+fAS1LB;LT(6Y%8esljuXpp3L9QL z(t)2gW`r(OU19HAl!FT50f%7gDiWKjrFmz8V$r!Ex*m-+$O;^SugZuzINKL?q3gZ? zr^iO-+lD-Ejwk^IfFd+hH`jzWc$|?Y>z^0TG;;vwoRAh3k-i|EcSJ=^b%DVo^&2uG zT+E8BPPSXSST=f(yjBJM=dZBMh9_&ph$o)j8aM!5bixiE-v}6b$o7X7jfC-{4q0e3lyP>rOL(+>P z)F(`YAZ{p$ft&cXJ#SaTgAH530;l%98|rVi3Qe9=Le`gj&eeE}G(1)wnWu` z%(VSTa8bUCUse>zDwz$yVs3iVTJQYN#!wsTy|p{yBlnl_EDMS zUx((XrnmN3(TbNdV&FZW7}0m0r`at+c%w3G?zv-$@TW6-S%^&jh_pyA*_9TliDp zP*A|hU59s-*4%4A;DU~Cw+5+J#>G6#V68CdIPP+%@MFr2uXT46n)k3GNzvOvosk5G2^Kiho|)?*MLd%K zss1p8#gn<-twBVtX6ew>vo*%7BU}5jhbIBJMnR(hiNacQ#%VV8^T;}`&&|?(TXi;I z)aTQFS91~in&~Wf@k2A$#GfVX;KFY{b|pOZ18#rFNGt@r?-WY#iGcAaZEfKbiKD?^ zY4nqy&y9wo3>0sJbpSp2172-H+mKGtZ4oYiUGt7_qL(f35cZxL{kv2N)Cp$uy0U$p z37g-bseT0#;_KI^(zw;C6KaZw>AS}0MXb%Ik)=0{AC-N>JEA?+Z+A+-i0D5j9kc+#(%I{B()|pxpGudml;LeKH`aoZ&+=+$v!=|(vqfJxsrGh ztzZJ*4b}E2b!{vs9k=;mo5*e`V%U7cvGPPb+-CCq!WV4*%H)NX2qpbk{^rXfsTBFi z*fmUC^EaY9um^G7+UHsy}5Z@%cwNS;+3Txm46*$BU+y z_EiUURP=W?IMP&*XYq$#^`isa6zHlb`!Z?)u1Ib~$44OsMwQZ-Nth1V;)( z`ggE;L;8OP7T&3QMa`51z2uEVe7G(6Vb)CHcLFp@<8d)(P!8FXw9|vRWC6z!-zyM; zS^=hDl`GH`EgoQ_W_92`mtGe7@yJP{# z$$?dGd-DeX$_P#S%r&1Zw`t-CuB?1sV{Y62b8!+~^_wFG0CEQ}_mRwv&e!E%k5!|Q zdUUERtk8}6O-v1#KSxNc+)`iVtJs?E7|VV7n@e(S9&#>7 zCn9o7075A0}!NjV3RAI_*8fo8?%|GLer+G6_R1vzv(bM@u|k6dC)6q#6e$Vp}r?QF*ov$mIc94PU)(12w( z4xM-5nRu!!U0QY5Zj$0V(pKE! zQ@JawZWGfzxx0I+o`G^_~C9A8IQ1bJ2uonL9@;+ zgtWkv$&T55%r|REw>oxFQ?PL^x~t zqA5y9ms@sYK%NM-=VpZ5@A%2mm(ZIGx*2#IAA48Yy>x>GSR?Url}DOtoiKA}b}3A@(a29-2qC**f8+rsGe)MoS}v69k-A-q{ZzZZk89AvbevEJA-;(_0rNOd%{($C zyRH}gxFY<;g{*s~r$ZZMweFlW9jxf#>)FU^CIgHbsB`?S1)zb@r1bhz07kmar{4$Y z;f*XNKfHqY9}HpI9jCTng!rECi3cprbo;97wgx%l(Un`LUQN|Pfh|dDp#`<68&Ac` z4;$hoKnmsQ$fw0K!mVJ|o*xfg!R0Lz!A+%0_}ke|>+P*n4NqGJ0t}_lf9|3k5Y>frPh1Bh^lqju)@UUMSa){y#Sj!2B_KdP)vdK7^WTMjwp$ViB&bLIz`H9 zJ3WzQF#baT-fKIWt8{ z?DNXKD^Yv;i`AtU48sMgiYqU?gGpo}fF1Rjy-|HY@`v#4D1Ul4E};V;~@HaRq(u17CpH-JUv#a^je8tV7xSE;YkJjc>wKo?8K z3Yp{;iSAkO)i9$Rw-4Ej(_2a9&*G$tR~0hLiYIFS=8ZBq?`uI@?_~7kuH^g| z$M!CLlBWipiuJPT&~0`94-CwR`C&s^VfT{+xWqM9Q~Vz{T_ISO}`j^_dVxN+HCtSoI8Z>|0sO_GVaxrU)b_nA-S=C zUflWHgmC-(EeO8NEw={@eQS9|m8H#s(*tEv7O zLFc4U8H9i zj{d_vy?Ay9iw8S?`Of@D`0v+#@^SsY2h&0=&fUz!WFHYBeux|p2b~|9-m$Rliu`kJ zY?ZS<$;klI{G83Fe@x_!MN-8mEG%66%+m1jZ7ZI*-NrD3e3K38uGBqS)I+IPwx}l+ zmJ_Sc85=~BWl?_T_wQDJTKoaa8w+nqIbE!;VnWXna~PY5%jXL2b(_klnDjXA&7Z52 zUd0&og`?6PO|yE(^RjV&;&*SU!m|CwGrR_F4{vX6^(`q;0{lzm{w%@+8w#`##uJ%VWDqOMK-FgY)0sn(zsSB9#=UMFT|F|uZyYDF)#;ty zuiX|$uw8Ld-@a+%rM7VQRveKetIDg&6Lr~5Ot&&J7K&`Rdp+iP@IYbK-!Ieuy+occ z{KWyU%_Tgz<0+&1W%Osaj=pPXx}w(f%{E<*1pNA`jQFo4hca2L;jH?KM)qU^&|Ctd zWEu6Wen*=xZ;h-TnTK0z|4F#MYRCNW5&w3^w$c8Mi;T}ZK1tRMQA+tmwk}BT{q$Fo z6(&4!KqcU*QH58P>P1g%L(S?6KFb20N z8euKRY1{L~FHv8KD|A4)|EImL{EI6I)()275S&1m5Znpw5`qryPH+z%+zA8-uy}BH zXK)?d-DQE`1RXrUz&mXA{+8T-;Qeyv)0~<<-Bop}o~qN;-D5LB^{uk<*->e%r?+9o zuulD7?{(mhuezHx3>ITL6Uw$bW2{@Bb~h;ZSd5O5kABA?!+x!gEVypwbK=hiQteEbp=lL7Tl72YA3ZqA2f^Ga^g@v|W zDlvN;p7pq{1oND@0IUrZ?kh<3JK&BD=@Nd=Ll#^?+7lSKhpiO2H!6VuOM9_+iO2l8 z$tbkuhvq-!GTbNX=s_S5{~$q|rBoS185_pFVSiHD?bpElEPO!yZ_TmC8TzOqIuw>P=b>Yjb0#+w-dl^>pU6NgF&exk!I*s~m=k{ax4C-95 zf{*FwXkC9-HS#B=teS7nBCebN!u@VO+Def`@CT^IBhd?dZQo9|wpebc+6qbiwgb)( z^dz{IEA37FrDNAxi>R@d7N_f-blr3@WYV4NCH!P-h-dk#kRqQ|v!f%-ntiKwj^% zgeL%~iVMTKnOuq)^#AO|KbZmsYuo3w+VuZ9u%g^!IEal@Wq+b7t4J8~Cr`~;75!(U zBAkyPFUO}m^2D|NkIDbjNH=RGlT8Ain<79wjtxzJ`MlqV2KsmS~25RpELOix-diLyO`R|8r3h_;@iGaclR*%=@QQs>hv2M)Xuq({1fW zNR_N-J$_A;x6aX3t5frj2}j1NNN*=Q*Za6e;h5+#0~7lOfZ{1z>KUyK??uUo&3*Cw zSHEFn=?_$|a}Z~kN(*$I`mXa_^UH0nLV!W(ysgAHs@F$IjcZVv0_@8fV{=nx z>Dydu-3>ls6i0;F~nyRQ%mu z`Q>&E)70MWJiVJU5(*u)GLHHQZ3&T@uA<6%7(SWJrinv9Za=Z?O{EQoY_$KDM{P~6 zcly+dOm$o;xc8iI`7a`1Rfrr_k)xI>#qqTT(H)}#)P=aBl#MVQ8ZAa@vl1dI8sXsN z)Kz;DN3{}@bd8QB)D-rxy7EgzTrD5tuD)#PoNkiqmdagdPM9b~ia&qE(OH=iPg-i+ zuV$QnFmN8AMQ)5It(y-#=tEJ7=qV`}I%FV~q+rbP_$!^VaO zj{v$;K1bJI^5lTHs%Qm}g#m!OfKIKNkJQCbyQ(3V^`h`khRh5m3KhhR@+i65?e#;? z7Io{=Rt>^728dh;aoT?seZ{{ZU4n1~Hobf&koT8y2uNuK$;;Q*#m1}ktB`cNv0iq9 zzZGB_p_X!c)Y!Sp~P1_k4ylrSTk20W|g5vJBC} zs-Q_`pFK?V#IEa!U4hV=mNt2ES0|jTWW(!QEHT{nfW=6Zdv?-(>#>O1-1L^ND&K`K z_<1)QcG7IVl3dIXlNvDnu z4{2wHNvD>kVuCHR`^T@|s1@||M^9a`(#h@!fC|%xm+KQwcELmHuZR1_%|D!F#$X)) zx&tSOclnhKO4$$T8dLa{9fK{`wX&Xpb_L^CxkRVz3O)}<>ewi_#izRU==U&lgDxKU z#N8$Ek_~6^GH63M7=|w70p#gl@y2Zj5Zfeda+%jC3xT*i1sMYZ(`83Rs{5JUXtBF`dpc<3PTW_rhUr!b_)63P6 zX8tTp@l?R?$Q@`SLVq5DSI{Pqkk(^i%#6nE3b9vVWOR?}4Sm<$)BCQgKJK*IcTS{* zoty3@Jj{BQixEHFzqvo9VqOnaC_sUD5|a@2&3k(8dZ>_#$NS5MPx^V#Pvt07iydS0 z@Q1!TO{5_FwJ`pyU~=@uOx(1BnOrTLm=+iL$iC)X-Ng(zDIhTkbWf_n?e%R!QS|6q z{oXkngt$8vx2rgMSkaj;2NdTGeyM;%a-h7bI~2A+tco#Ul+n@Ok;al~#dDxs6yEid zijvWW(&SL|RSF56uM4soam5-(($3K-nyqdoi;z$`&CEA1%1B8G`q6hvF-hRg-j9wz z5=$uE5@?H`Qj(ItddgaGZu=-cJ{M;G6MYpTsq%P^GZbtRG~GaZ-) zoZ{lLTv<7|m75QV=ea^m`tE{`&K;)9!o8igtO*Pdckql=y{gR6Bhbu2i<2ndO6AhK z>Q&fKHc=^Nx7Apjp8gEtM$`?|g=r z#_qmj>5t^}A7uH`niU1xA7_GyNca>attSU9^j{Y_8=e%kc9EDo{WE=ZWrI>u`QLyAVncE z_2mFL-Z8!Nc%M?H%c>3EU_yi^4@o9PL-Sln8cQM$`J2a3U@!Ivet#1|<-)Wte-_P* ztT_O6%ilV8QZf@HZkWBt;E}XuIB#xlHYib4c3LOS%1uP<#ua*=9GRh-KSoPeEGp;( zw`UAJfk4DkzV|X>8N**p?|m>}%wNuyMZ@2EUZWJdrwUyYx=h71T(Mh6sjML$&E5q3OD_3&ck+YlCx_|)zY z(YCD{4|UO|2|zi9H9ccu-gt38hP~;#7nsGPu3r{Qa*LKhrb zi%QkooOb5X>0=fQE1!Z;$9$=*jCOL?I6u_89 z&SX5ETAok5hq>1tAp9DhaFMwo-QIJ#ntRpiI6I_jh2XHrPyE-s9oiOeOuv|DAjD~D z;P0?Y&3R!%^1Wm+llB90-_}#X&uoDW$kx3+;2>o95+I!mkqtxVRr~b4Qc1h8|00e1 z6vvm^lyneQrJ&Utnt!s4_n9<^9v8VW8gqM7ga)JI`FCKRk>2`=o1WD*Vb9a9xeu11 z{tS{B7EpuF;2%Ikt>;abu+x!3SI+k^5)Y8bEm=C1OR*FM-{;z9=#mhpf;$R~E2Iw55Wj*%&yPpiwFwtLw^BPd8uPcl znMpmnJEPZVF4{Rd-vSb%xUKET|1Apzi9FZ8i@6LUZ;F1>|u>mF}BbjIwWk8$sF1P-0<@lP5+Y2 z$aFs%;0}IWnXfE^uEAq9zV5Yzr<{;Q@%|!SJY8XD&LmRXNr%NV7zRkA;DuLaH+Bxi zV!7FVYWh(ZP6^|`c1wl#W5O)S!!%hJ83LKG6|!E^c;h=gil2M2(|-pz>lcq|DklwWL29 zmMg;IoR=#s&Lv$dVX^+a6!TL2!6v7g(pOW-+cLF`@ZH7ZGlxWV(?s23fJ?Je9ZS#c zifcbz?Z9bA0ZZy_@fm}YPDFXV>$(%owC}8*c8K0!w9BHi;^m z!RaH{(@9+ilU*CUy zI%<5e$Vg$67%oVvee>S4Db!^v_H$!`1!VF3Y&@v-dda>9=&*46jYZ+IMM394@U-ZR zM0mq|+Sps70r}XA$3no6VpLgQZGT)NZcN9D_k2RUM!T#_WcT6S ziSMWjY6pGcU$}g=>w~wlINCJU-<1uDRv)0kJwiO#^}{2=VQZ|PgDN>Np0qr^5w z%-*0TFfK*%o@&S*cbK@^y1(0T-XPjxvnC@YkQS~V+O}-)jbq8k*uB|c9TOt`pel=; ze>l_+HD<82Eh9QT+qE*~3ov$fl%i|gSE$=5Zi*KAgzA7`rFk*f%#pOn%Bfaq65GW` zjBu1M98x&WZD_?lp&AYB0313pKWsekVKUdxo=pU2lQHWN%dX!^F+beTwVapx&vKbQ zUlH-Sp~u8f_>mY@_;K8rviJK!n+*zp9w1YfmT5G=R+nNdTB2R&U@v7h0pX&&a8v`_MchN#?wdrs$E@vzqE$Rj_%K1Y1P+U^djN@8jY@ z{CU!v0@$RTlrEh7uCAD~eP84Q5JFPT$IClxp|}Yk@;ty7r{2topy#s1j{-=vmgT7d6gC)59Icf!v$HZhwt$%^;S3!w`MpSoc8*!l^210hm0Bu(MJx>ss%WODJ?K6=MhU zF+d-uHZ1NCCPo%fL0pw|GgRx4%&@ZgcZu^ifNh=%qTFc}Ij@L-JpXA^37y5{RMX8Y zwIz4yU*EMLXO}MBx^A&rO(J&)ebKoZxP<)h209e!b)n3X6wjU^GCclAKyhe`dSx8A z$(j1a4Q^pd4|4|IY)c`!nCdQD9f)}w-fndAKOa1CSSf>S#a+l zk5$w-R;^}1_OYa3=+xHYZB46k=fM=L1|>joHA}`e+l$#kXRkLZ(t0Py0;RtaxyjwQ z5FF%hF4?PAU+Lb4On%q`{5pw*eETdz;xtuPCiPl8ay=?)hmCF=Am>c&;t!)_9Sl2&oj)V2IcDJ|WJ}gL>AQWKs+i+v)GoXFc&;i>1q_6@ zUG`8jG8Z0Pi43!ybhaI0-=(~2{Kv3_?0=jJ#%jC2*{^7KDte&y7gq}jMcF^4d05R2 zZ8nQDMb22it|->@Oq&gJohyz*fjfq6T(D8ksz!>T`grftL7)o;I1{Y0{_ac6RZK${Sra7Ef)npVT0Y;eXy5k^T39 zA_3R?{TiHX5pv`#A>)-c)nIvGm z>kR)eDt}7$yTaYwI;5sGz!=K-gO1%0kL-4V6I&mX)2;p|J0B@vY;xiJ`z#-o{SQa_ z??nRKSRCRC>3&~7KIq3EZD3s1NB>p!XZI&K@HpL`p*bJq{^$PR?O~mZwnPNkeECB|OpGLP* zcK)C8SH6S^B=NrPk1pPWfiMn_sUmSW|Cjs`;0FXfp&@y(*Y`BfU>|95`48pqKL-3i D&v~;3 literal 0 HcmV?d00001 diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index 15ca7f3f2..ddcdcb493 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -9,7 +9,8 @@ Creating Documentation introduction style-guide - setting-up + setting-up-environment + include-documentation api-swagger-guide converting-to-rst addendum diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst new file mode 100644 index 000000000..821ee8c68 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst @@ -0,0 +1,150 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 Nokia. + +Setting up environment +====================== + +This chapter is based on the `Git Guide `_ +and the `Gerrit Guide `_ +in the Linux Foundation Releng Documentation. + +Prerequisites +~~~~~~~~~~~~~ + +Before you start, you should have an LFID account (sign up +`here `_). + +Installing git +~~~~~~~~~~~~~~ + +1. Install Git. + + For Debian based systems: + + .. code-block:: bash + + sudo apt-get install git -y + + + For rpm based systems: + + .. code-block:: bash + + sudo dnf install git -y + + + For MacOS systems, install `homebrew `_ and install Git + + .. code-block:: bash + + brew install git + +.. note:: For more information on git, see the `Git Guide `_ in the Linux Foundation Releng Documentation. + +Configure Git +~~~~~~~~~~~~~ + +1. Set the author name or email used to sign off a commit with the following commands. + +.. code-block:: bash + + git config --local user.name "Your Name" + git config --local user.email yourname@example.com + +.. note:: Your name and e-mail address (including capitalization) must match the one you entered when creating your LFID account. + +2. Optionally, change the Git commit editor to your preferred editor, for example, vim. + +.. code-block:: bash + + git config --global core.editor "vim" + +Installing git-review +~~~~~~~~~~~~~~~~~~~~~ + +1. Install git-review. + +.. code-block:: bash + + pip install git-review + +.. note:: If you don’t have pip installed already, follow the `installation documentation `_ for pip. + +Setting up gerrit +~~~~~~~~~~~~~~~~~ + +Setting SSH keys +---------------- + +1. Generate SSH keys. + +.. code-block:: bash + + ssh-keygen -t rsa + +Your public key is now available as .ssh/id_rsa.pub in your home folder. + +2. Print the generated key to the terminal and copy it. + +.. code-block:: bash + + cat .ssh/id_rsa.pub + +3. On the project gerrit page, go to Settings. + +.. figure:: https://docs.releng.linuxfoundation.org/en/latest/_images/gerrit-settings.png + :alt: Settings page for your Gerrit account + :width: 50 % + +4. Click **SSH Public Keys** under **Settings**. + +5. Click **Add Key**. + +6. In the **Add SSH Public Key** text box, paste the contents of your **id\_rsa.pub** file and then click **Add**. + +.. figure:: https://docs.releng.linuxfoundation.org/en/latest/_images/gerrit-ssh-keys.png + :alt: Adding your SSH key + :width: 50 % + +Setting up CLA as an individual contributor +------------------------------------------- + +1. Navigate to **Settings** — the gear icon on the upper right corner, and click **Agreements** from the menu on the left: + +.. figure:: https://raw.githubusercontent.com/communitybridge/docs/master/.gitbook/assets/settings-icon.png + +.. figure:: https://raw.githubusercontent.com/communitybridge/docs/master/.gitbook/assets/agreements.png + +2. Click **New Contributor Agreement**. + +.. figure:: https://raw.githubusercontent.com/communitybridge/docs/master/.gitbook/assets/agreement-link.png + +3. New Contributor Agreement types appear: + +.. figure:: https://raw.githubusercontent.com/communitybridge/docs/master/.gitbook/assets/new-contributor-agreement.png + +4. Choose the Individual CLA option. + +.. figure:: CLA_types.png + +5. Click the **Please review the agreement link** and then click the message link that appears: + +.. figure:: https://raw.githubusercontent.com/communitybridge/docs/master/.gitbook/assets/cla-gerrit-icla-proceed-to-sign-cla.png + +6. Sign in to EasyCLA if you are prompted. + +7. Select **Company**. + +.. note:: To contribute to this project, you must be authorized under a signed Contributor License Agreement. You are contributing on behalf of your work for a company. + +If any further prompts appear, follow the steps described at the below links: + +- `If a Confirmation of Association with statement appears `_ +- `If your company has not signed CCLA `_ +- `If you are not added to the approved list `_ +- `If Company is not in the list `_ + +8. Complete the form and click **SEND**. + +The CCLA manager signs a Corporate CLA and adds you to the approved list. -- 2.16.6