From 57730bcfbe7749cb346abec32681e487aa05eb38 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Sat, 18 Feb 2012 04:12:38 -0400 Subject: [PATCH 1/5] Add versioning chapter and diagram --- docs/figure_src/versioning.svg | 211 +++++++++++++++++++++++++++++++++ docs/topics/versioning.png | Bin 0 -> 14432 bytes docs/topics/versioning.rst | 25 ++++ 3 files changed, 236 insertions(+) create mode 100644 docs/figure_src/versioning.svg create mode 100644 docs/topics/versioning.png create mode 100644 docs/topics/versioning.rst diff --git a/docs/figure_src/versioning.svg b/docs/figure_src/versioning.svg new file mode 100644 index 0000000000..e5e64cf1f0 --- /dev/null +++ b/docs/figure_src/versioning.svg @@ -0,0 +1,211 @@ + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Original version: 1.0.0 + + New major version: 2.0.0 + + New minor version: 1.1.0 + + New micro version: 1.0.1 + + + + diff --git a/docs/topics/versioning.png b/docs/topics/versioning.png new file mode 100644 index 0000000000000000000000000000000000000000..6ec2f24d866d076175fb71358001441a72c8f185 GIT binary patch literal 14432 zcma*OcQ{;8*EfvOMT-`_6TOU#Xd}`XJtRtq5{!r*ZK9JPAqXPML`h6^K}N5GAc;|; zL}w6XVi>)b_sIRc_xJttUC-y5GtTU@%i3$Lz1BLvz4mKkLv4CmE?N>25_*`$mv7z- z^aQW&cTc3L_<$D;6~O^ZeSu3pnm+wd_bi`)!}V$;_Kg5_B=FG{F!umm+z3!l#4x5?q3pg`&U$W<>nahn_SCS;bjHQMN#hKLdjZEEhb-gkq7k9^YuxNk-r0r)s$7C zC?}|RapgI-1y|9ZF&B4Q22P6GEB7# z`*iYqjR186=f!vyj{+MCDA%v-3zCUcBa$=jQSsDw+WG#K8RJh_%1_x>{rkkDS>>An z6M2d5ziv6$GIO?6z6)Q~8nZLDdQ$UqF5N}K{=;t`Cj+SI+{p3HX3^taxLV& zte&Kv*OwjXqrZ=c+6!Bto$2KavU)yRm2%IEQAa)ydkOUGe%D5*z$D7xR(IdS=3ji5)Qz>{nLh;*l2$lW?LqeUhvzbUp(*d1Nb%K59#0+;=RV_x+-Hs6Q- zO)oy5lEoKZkzpg(lDOboZf{}ofF#1raKgvI_sD%$w>!K+mB6TtRyX&%GC-F;%Lk#- zGPe9r)$hx?91s$}$o*yM`CV=Rku3ZRy0DgaQ*z3x^@&6PQZ>i*1m(vF_N@Z39 zLsR@`=;1#;3X+o4kzfCfIwD^5_MWGa_~_m2_o`rMl8LTK`>P-%}^U|Fbx2gf55#roeXVLY}|^l#IUM-v72n|1kil)p;T9 z2~OAx5nd6z7py~1-MJ3cT074tEc&Ra7y^0LEG&}s+icY8k;tjxpubZc@outz+Hk?Q zh0!G6bkwv+bsc*Ss@Rt>m;Bo@B<_X4MaOF|Q6Es~h=7Rgh@o(E(MK{xo^%EK6nn0n zYriS{ABo=Lb`HX^xFecJoEYtHXiw`8h9*PFX2`NhYb57B7|pltc4BT}ZYBSIvUCuN zxr(#L-NZeDxga>PoOG6oK^}dsfCg=nJrmi8Su#{Yk7C_Y=DlF?vWhP7 z0OUBSyPZ#r>4|=_+0QhrTL3r+_1S0gZ9sTlc-vt@0Wy;|b+ACeo*ORl;s;;lK>J3JV zLMJzq&rDf=+YY)W*XU1j>ozjtjZ-YRl`9o1C6|lW>2^g8J*s9aSXIh zr@kF)mOg$PXM?MQ_o*--2Cy>_^h0abGAhC(Rs~ok7v|y#KZJ~uY+w1SC#!MX=pZR2 zsWT~menk#QBZ4`@M^^WkK`+N4Vme~RB}~(90lUdPZy*$aT5X~_5krSD&nVT1RS4UJ zr%enTZjO87FM#j1#cqz&Yc`g1_R`apD*zJLrZpPSVcZ?yA?F zr6c6L)GJ{Zk&S-e6G}`x#yz@J(9XTa!QRq6@0Uj6OIY+kA zG3=YVTj4l?qxE}~# zldzBU;axA?naD*iZ0S4vrK|cNZLhuZz zrF@?Vu;|)->NKS*#MNib8Szq^5B)G2buo^;_s7C~t{F^a4qr-Er|9gxEi+!lQ^#`P@9EPX0||CF@OW>5&H1P;1H{2u(^t50S|+1nihT=dQxhP;NN#bVeh*-`}t`#Kc0t&uwEQk9%e5l+Q25us* zSY=eSVET%fWL_?AKKG*KO|&J4$fIFfmafW*=;fhGH5|qIF!u16M2`I^ScfZ;qkUnh zdXFqy5xwZL5}*n0NtkdUjPH>xA;+cS30C|$7Ui1IUytS{9*hTlc8F50UJF+q(r|;D zDvnNou6V-HirvH*Wmvp2T3oT4f$TRJt&mYcNxa^i69s?I+xf1#SsePeH2pkt9E$}v zIl_Iw%k)Nb{G^G_$eBT7gj3l0@bVM>rv8x>ID4E8FO|I^DX-k2aY=2y0~LfE zw{cPe41ewrv%x*Bfop}7eO<`w>>wkMrew(-z@uip-T1$u?zh6i|4(20Y1?Z+#6<%s zc*8b$CZQ!hIB-7hT&8>ZzUA-l`{M_HoJ@P&47;Is0Ovc9^{TI9I$epQ+w8!1hZ_#< z7&?C%3{AL$iM$J?+hkT9xnZyrwz*%u$>~V7Fw|$%Q80BbAHsDE?Zuk;ZPf!|1e425 zuGa7}%ZrUzQ@^A8PAwcYK8Q24d7>lDZ^Y5tBpup}ed!QyCJcQm;FrI2C05Slh%dXlISuLwl6%Qf zzeR0t+J<_wD1h@ha4WnO!LgxYoK2eT!nirej>>SNGLiF-CPOZuhdf>frOtFj8EO&U zP;^0RGM@p#b|R`eTqYLUv8mKZxxOjGE-iK1-#0VG09o41Xo%Ao3oY;XHJ% zEKS=bYe0>py*=1>(EidE<9byYN4I)9ip{jztnYct9y#?c@FQAurnH8$rD3Q0X2C|Y zJZ~5i`R5c#PVTQ?!^g=yFLR|q9fr;WyebDJqzo(v=kq3Ue1u5xAYL3zaMIvp-lySR zU^;?2T$I6_*ZFK+mji<-@U@v5mF+qi8(v(r+3n7p*@rD;Z@QYzJ@2kbQ$sz(W_l@>a2d@r4FXq_nifuupk83udZ>utiaFfJmff#*m&L)?fuAJ z@LR5+i}yE~h_%hLJHne#5(lrOZ8G@@?2HsLNo#-3!O>7H4VPW5Z}SP^D4%Ptw*xyfbM zi7PgJMf*2{&chdh<%hc%iqx^?LaEE``EdgHIE*MJpqG%dSX0oLa@W-D&aF!HwHfU> zhjNCEr@q&%IbqzmZP8w3^tB#$BWG=sFf$KBF8vVggUDB$o^Zd#uV}SoRqk{0>s;6S zuzYf8*mO1%B#Q?&f+>%95s}wRs8&R>Drr3xn@TtmD@{5m?K}T$5B^=ZZgU{=@l4N- zq@p^b*$SSbO3%rh;%>-A)}(uj8C=uYo!9pg^&&hB$2MRaomLtQ=)*T1F0!dNjMeJD zuuG}qsN7VYzi}Lf<4`q_%k|5v6yTr&fC=(05{aYXo8hE!y@a^M>SA@&(wq4u)UKDp z2Q~%I`#*W^r@le$Mj$sb5{wA6K8N>(1l?36k|FKlBaLs2&)K3-5lU|DT(8T+z^dEN z+puD3z2E(B4@zK|F(Sd&H#0EI@V%Rs^sdf|+3BUq@GG)gUxk+Zz*hHU)n1GUKOYaH z;Gqfb!`es#oB$%QthY)5?WP!FFQI?2M*K;bi9xxs!>nk?(;{Mt>6OYED|0I2^$#9)l|-o_B;lcovwi27J^DjAK5(+NKT+Qqvmmhm%p3LUI$dd z@Gh6`0nd&r^VUpcCBdpi5Z6QvY%y}c2@{~X+~TuGo^t!8JgI=){J#~oY9Mi08GD)N`lmq zZDR>N0R1b$DEnp0O0@7y_Bq$Ct3!N;+SPu!v@A=JUGkP_WffirxY6g0RuVbnxb5Ix z0PwQIf+f6uHa^K(R30x3fnNfBy0blz~Jfg!=$e;jI5@0zgafw{?zK zT4Z}Z&Sf*`3ieW=C7{FVjk3SlF+6`e`?_-yp7!bLSp?Hvr`VSb>Br7s37!IOCS%N) z&L4ZW3vo>TE8qEHt8?>Cs+KU~+6% zzvbAdYLAW+8M2|QPi zS3ha5X6phljrfg0wu4Khvof_ZTE+sq5i*| zRO(_19-LC?GDG4&fSEi4xznMb!Sm3%x(uWn(rV{);rtht`yCw&Nn!+=M2^P*X2PTh zfU~A~VT~j)xDX*AJg|f7d6#!pJ)1NUDC=Zd-6Vf>862cWb2LlRoeB^j3ZP{T;3B!U z&zOw4Glock6?W@O1VNY9XWS-5FDoSEY`etm8*8SbFW%bM5;J5d4XI@H(5zJM03xH9 zw6s^pbYO-JUkqHT&+y14mEPi`+7^oBmHV#;L+&;>Bh9uL&+z%ZjQZ6 zlv~i70x%Zx=}TblxFC1vBM&RdcqWL`jll+t&A}GU1s<^f=P3@QIBDz+(7w*K`%+grTNtE{Jwo zmi(krY(Qf_wE2O=diIwT`^DH<$uSY6$u)Adf~f%1li+L{ELa5uNx8_BC51+s>tCm8 z?gNO9>RTn-wi=AyVvQ&;^oo)?6~Wp=STc$UvKEdq$n=u(pwNe)50eA+RIBpb=>R-K zl`5ImCX*u~EA#r29jwyMPm0=p2--w9b=76^(?(W=LUJG|fV4+->g&a5=!z_qZRU96 z4Wd%_c(=&hHa%dg__iCw1l=Ygh7}Mz8@@?(<1`31e&$_G%z~3V0Q3l~@J!L2+!!QA zC^%;3iSR}l&8rsc*Z5i99IN6#rwk-ZbpF<>gS)N11$Bq(^*C7r+%)#LAzvb$CHXBz z!wt)!_yQuIGKH)*Tm^K+(fNGf^J%sbFq$Ha#xp zT@qt@H~Qc^g9-=aUz#Ia;Cud@288676)xgfH_8pZFLlQtqkN*q=02aK`U)g{{26Y3 z>17;Bc;k6?WUiXG)Os~O!aTT~^oYa{!@CGBSq1!C$f5FjHS^h*)OP3e@na{nB=ygZ zI7~|XYveF&i~W-(pf+{<%ECAnpjkc0;y!Clq{WEZO7;|JC(phW z9a&gUBaf?89A_tYYQw@wJt1F9s5YK-KQ!e8XtcF)TnuPpIxymNqltV5<|>cc>((a! zLhr_C%{WZbe>dhR7rEt`dwo3-f)-tr&o2Q+;e~ay@JrHuAt>>y7P9Rg%iMiO=ZwFc+x08;hok1Z#|n4WBZ-ZL~P57 zF~6_5%{Sy@x+_V1W*LC)^q(FWL%qx$3O91qwn=t*MbTIox|~w0Rv1iZ#57%5YW@q5 z?TmF3Yxzcokhx~I$Iu`np}`vPt`y`U2hcN+QOD+)p!kV@=_zx2zQchspQUrgIMpIV zjQXd(xAqT;i}!`&2z6NxA&pW>K#!x@5#X~4p^8e5^@Zv(mp6_>GnZNzAl zc8{yUC}4}aH-v0%(eFQILIf7}xV18MG`%3%ph%vLx1TA|rbaRd_+2{YhN7P``MSnN zhsc3Er1LI_Ik@HptB+s#`+Yk-w>hcmONN15Ew9!9=i42MU<00TW;mqs%@Vm*f#A>B zk$>1FZvv`1f)is6wkiR9qn5GCZPWWqT#uia!QgN zY&dMJ?D3l-X4VnzCzJE583>$j-)<0iqLJhgnd=xRT{86Cd98IEUhP)`kyH^+Z$ykA zXl8q-h@46d>H$WrRR6!Vl>%i;9MItX$#OWllNEFQJlV-{z8e_91nK>6o2&7`A1@oXSKhrP{)G5feRU7tM(FI}94Lt9 zU$3=n4K~zl#uL=Gl0!$bhJaWe{z``ffUE}%n3RmPe%7j%p@?ditWxOK`HgtH<`?~> zE${V&XOEnC%^Dm}Z*2X^Axk5po9x*80w8^N|J$}Ip?KKQ>e<5|ZBwE>Dny*j^TSh> zKO#rNfAFSRRA9)%MrEnLEA%@k?t)Z+SmP`yjX~03nwcE*tF)Hdu#|4;lIoco{0-hH zI!WaB(igc(TV*m1m-4Yz?Xs)oKY(len*!xqPbuz3Am+>zoQ=K2B_O^z7x`H~tCjV> zElc(N)M@vzhb8jvmQ21fLTHA_L5oyH_-5=w_TF;QAd`=8EIs41?{zV?=UZ;o^IR6y zR@IieBaMFbRBK;Qaa91|8Z_p~3q> nj4&rCSeX@~l>crhkq-wH2gpU`Vp0(sH@K z`00%c8(snT|DajR$iSG>pD<5vddC5N~nR|EEvNkbV89w+kI81AtW2S#P zG4}I|_8<26q~h2^>s2GRoAv4s>YoDCKTzR%^Y$ia;`{giX)d$j%{df!m}8n<9Lxq@ zGJ1SM#i-!)`%fZO{Z3i5U&)<*5T^iMcr{QixnH)X20}5h+51{d;)!%O z;ZQAbcLjtQbc(y8cKDo+aDK!BspZEj-T4zlH*jh zqh4jSjSUpm37!VZKJnbr6(>z2|sK5ezYj*(8#R=>K>8e7^@AUsw zZ*AJ9?h5r1Uk*Oo*UvatXKXoT$(OSr$KryJy4APIL#}+KH05~X^tZH<06q~XQHO5cjQ&zd zaf`~cXQuvzf8fDlP~Z6K@aJ-!%&{!>tdfB^)Uk1D|GiX}2Zu|VBZul5#U%)bt&}&R z%Z7%U^FrBy=jQ5~_&~Uv&9|IHrL$m^g6rnZ>?~j2M57ax0-j)Y*FEC#`Q9lsNVlwX zo>EI(EQjU!k8|biqMwU}Ma7Q|f0im+1PE}Kw^I6;y;M|Iwsgb%T*4o%;e+JHX@THF{|3&2DV#M2D^fM*zf)1nO0fETMoq?+terL?Wu>;pw}PIZ9TtYjNI%P z&J6IgstA@{aGvQ;K!zr8bZG`DZs;}KdkDmyS0u9I1A~sb^T3(H1(Jck0m2t@{)9hj zXUYFNR0Pw1IR zTx$4-;uXv3xF6uzg5qVjrM?es5!^Z2S#7cUoZI-`{ya%4m9`FIcFa@gO_gX;jg`A} z-=iyBUf$%9svEZ2LM)3E`#iY6Xm^zSYnZh4=+DpIj4)^ulz_eWcw(M|cE8v~c<4p0 z+lAdI6E3*PIke?nZ=KL&w>Ma+<24|*{Ka?bBXTrGLvd3bF7rI^t!(21%h@u%n(CE> z*7u3GX6#+szV3&tXR?1^J{gN1+TXfUGC)GY@#`WNfI@3j959DZtiF!?d9J6Kn@`J^ zfq+&QUH0-m1U`K9}en)fW?& z-_Nu7NtZwBV(-{n%HuSW_kE>ZI-&aAsY$unH8-F-$hCM&{#4ka<(0xW)eNmW|19=R z`^!DdpySj(U(C6j4nAwNv^^@%`B7sPq+(*F_aZQ$oNMI)#bJ{<`AjA)U4akxbgA4! zz}Xe{1?e9Gd$bSzX4YSveWMARes6zE(3W26sY`|8{luq*U!L6)eo;FcB_a2W=9l;N zLXv+jU?s_6yfd-ofvKz6vud-Sm2QVxO_~c&DGhnMk5-=tDzver^i$YOlZ&QCEd&+9i8XJTdozB{lc85^I>D|B7a<` z9DL@$*?Rk5yzOuCs)M=UMoS6G>wjqMyn~=dOupn7<_tEx1lMmm`D6th^S$%Py<|`q zI@%q5-@VtWdI3_c3gMS$3fzt4$j_oeJhW`O0`Ci_@l>>*usA!J0l&#ZerEH_`$4UD zb1)Orl%D^Z8p+kB05+!|Pu?W9;X}HUf-3fWR%Iik{ z<7>{OMAGfXq0+Zni-Il~)!Cz=dc6ne*otnu5ETQLj@6Zx9(sWCN%a~`IRQUJ4I82s1om>d?R$&K zSwIraXTuU&^$~ByBP1|W7AAr#fB!jTL5akDlS2EEpXurY&SN?d?ytPZ_jm2D_!V)z z?J$#e9Hc7WI{3qJg%L~69#Ffe4fxfYnZ+8~tHN2IeF8~cNkI`U!$!`J=%h*DBoZOsaigeb+L9MwrT|NvgBig zX_gb>n-yPmZ*DTMVyIQ4^%om6Q%56;Dc*zprmNrlOExLE=$3jS^1nOvC4=mI7q8Y@ z0}}r#0C)d(<}VUzVg>)#Eq;$E)UL>`Y%T9v1hDfy=K|UAfYmZXlA+=*7WHcuydu1E zE?J6G0pX~YGWCL1RPsU^N)mSZ(DRY;jls&~-%>!!*C-?1iH0fvDvspelC|_@cLtl2 zzx3w^z(Pc(#a$MjP5i!;NSY&C%e?lD3)6@>;`O@)L&8*V4aVaGi1*r6T=g1m4)!E_ zq*mRc>m~}}3BH8tUf#(kZNe@|C`OU8B$`!m7nq(h@!JX4SkctoQn4@)1YZbrVKf+n ziNOTJ@~kB9i^RX(p_S)Nm%(ex@Z_ZIP}%XxKN@sM{_S4kY{4e7tM7gK2-d7P_rml5 zzF1Yx8A|15>mfXm!9Nf|k&KE+{*tO>IQSUWo#xe7YpR|tjK^OlZnMF_5saeEqAq`) za?g76Tnc8sF34g=5lk!Rs3xpQem8CMmH%UAFU1xyd+kk_-K;OssB#NCN3Vl^qe)I6 z{g9Oqraws8`@vs&_i!?__fcyRmmj10&Fo(~2=m=70)@JG;Vw1sWtEJ)pB z)U`j|;HWlTs`HDmCD{j=lTE_+PARV>wJe8glI8RgG%2pvy*}m#1=Gk8JUUoT#ePJe zgU&!a^nVnWc_>dn{bS{zJ*kGJ{)jd3WXC4I{rw|Nb+ji3kan<+8NtkQRc@j&wXy9- z`L6V^NsW!nwnvC|O%Wf0D!x9tAYj`o&`3DkC!8umEu!41?+{dR4<6)-BjU&OXj>ml z1dwd-+J)gLaf)_5LP52l-<|~JC-VU+ik%VHGRMMhOtiwp2yk2<{L3Mw7YrW6AN;E$ zUbniWO!I*3&HH(*v|Sl1R3yqXTgCtCI(;xnoe;}%YH0bKOQTq4{4MZucC0v|%k4U} zb92Eoxb@N)iS4zs$Lf!Gv>vjHX89;o_#L&}iq%%jzaGpc|8<2gWMjuy(@Unp2tJ!B z5$Zv1ojLE^e|Ns$ldJMn-HwReOAF^VRXt#*A6k?1(mF=(Fw}x5^8XcIXax^RbZEW2yOH`w_oHc>x#| zp9kUazUQr^re60BU2&Z1#7D-gt+SHWj2tEVxS41G4A_Uyza`zz4?2<1=<)R4^b*aE zF#y#(ZEqP0Pm67DA!|x)k?QQlJM}nB~BI{_xm@R76Z&p_V2#L85y1cKKZh%gon7f%j@3i@V|V9MtHsWzmN!yu+omGZ!ssv|FUKS36}gJ_Z_N~psI|yf$7JhW+*v}4 zg7IT@jM)}P@ODG88AIl4jOs`s{3asaQx!Hvip<|X=Hq~re|A=vZyqH&e`&ok zrV+xQv>paprwpY{YzhItcA=elAFP;tkVX=sI2y!zU@4_o!B5J991oLRANj#uTHkl3s_nIAF5&bd_enZoD3)%mhK?E7R3c?z^3m+C~IgOq`Q%WbK4_ zs?$$p)%akr?Zoj{^kI75d+h4;>hD4q8pG+rJwg1W+Kzo0Ca+2)*0H+F!Jz(=_etaq zv3dP-84EOZSFLVdrbiq%&AH%&nv(B5a&%~ArP}}b(*1qtP`lazZ?=7?a%abA#4J4F zoaqX3{e0Yawsqd+)VOIJFC>tY5XN*}ID{C%0XJH3!BMKm6VmsHAF>Z&Q^zMSc8&>Y z_2-N4-e$nJ-m+LRC+f06jFKdtn2d2_?kwtp%Jk);mFa__oj*cLrQJebE#n_#Y-dyS z!GO1wv(%O_`Z~4Gi9FfsW+bl4-siIgh%s?@V)A;(gI~mx60E=3*hwqv{;2z(2?~23 z4>32jrmY9x<9zBcb$K+$l=+DCG7C-06Qz)IGI@RrF#22!7rPTebnJMYaoWf_VRsn~+0&qR#T`&HZEdB|cA5aigGH8G{GD05UPqQ;?jPypi-m1XKye#0y7Itaxg-lfarL3!XhOi18qz#YA|bh%u z**k`ygAFV!y2$LdFO(xVUJx1&#W!@tdX<>`>k4zSXI6hGNjt|z^^)Ua?(8+ue@JaP zkNorTCn4<1HE#_co1*q5S`%mz%`xc)oM!*Yy)mUp+b-oBBFPp;?cl&Fo}*No3eQh#JHdU7;A8E%O-Vg(Rf#1@+}JROU`$Zh zm%gbyhU>!Hp?#R<3?%$ZQi#}w?ht)4-@BdGr-2shkUA!-DJ)nz&wjRnpoYQnDWlb_ z5M6uu)%bkV$2NaYt{m{q7zpZxHOUi`4%K6q0an&R4?NMD>mPZd3Q|Br`%CHXD;@4M zj89_TC>^AXqnv8R90X^%H~lJJVw8(~RlXtb3&NYW_wt6RjfSzijmF7n|Tn)|QF; zsb1J|1m#iMC$A3hYfaWDIh}J`*eoLkyydXjes)9MG^jA@SoZ0k(D4dY6YZsUA8ja3 zE}Q2A`Ja^gm#*FAwQ=n;dBQGXted#y8on(;-;HboCjFW-s9@ga&HVEBt$Q!B;Nm(H zm&0t+a2el7OAan|ayrPA5l&?Ih0d95=%9^J9R(!Zx__PF+ol#NNh8=L-G}K3^->g` zkyNUy>57Jb?;zm=Un9^gqYY^p3^qF7=by*J#JNrT?lfp?>)`# zYz^Bxc*vEg>37GT|Cf4VfkQ&OYo)8nY<>Sm=8~s(zh?xUx7?k)eR;H==qa5MNSu@d zHZg`>Vw-M!=WO8t?*UKBG^3vl+!vcQv7f=qqmMf&L*R+YoP0l4ZgYD<*(@nGR{JvJk#GsgYr#m&Dc2u+Z zPa2|P4MA8phU}V9DZCGcEm_vReddMEp?UFDLhOEl1V=yFGHY{(yGtG^R7T7T%pKGC zSJv%YMRNoPmQasf-u2C%`_j!1DldriV1=@}X-+_XdBiERSf@URXxf1;9@q3WV z;wxb=@}=eitd6!-6@6^kB!8T{a;k3I?$@0;euxknvmL~|&(<=bU#FKkHGAZ@;VNj~_Ujoy5V#&eo6UHTYvzE|BP$uRuM zQ+4_eo~@(zyC6hl`!x_Wx2U99}@y zbsatJ7A7#mSkzp1iTE%2 z4gN@532r38$G!39`OSM{od~tFCopB4+*9YKZ6mE~3A)i|((bL{wU)o7l`}?+xu{0sezqp5+}pTjqt9M!HV(?T*{B=fMuWjD3`?@dH#G{+hybQz ze+Q1_9ZiII&++EOUL|IYv-17oW1J`~5tj#ViQXrzYhbIo7BFw-Jpu}#k z7DZ^ZIBwZH?TDvIOlbo9MF)@o7~LKWHJU$7g(EFDcL4-1NN4aAlT!4)R@|oK_?x8l zI+r>FkZ*{-I<)|TIfK&ljzng5l_+%RPT`Wh?d=uQ*VBgwBy_~ zJ7756U1n0pMBJE4H?OiAD);Iin82j{xfMWELPyGnkP^+e(tJ;t@qucj9VQbQ4)EpA z3$5|{ZBhuAvxr2yU<2sp7#`yeGY+8O>s)}6!1vyuH0OI!bS7iuu*Uh+7f5fTnG(d2 zoEKxZ^Hg@9r2w95YW25u=oz~dV@DVd(Z|A0m43PGdBPtFCG?ME|L%o$0|XemhOZN? z!yJv#J%RU#@`eZLc^Hl!!o+%&J5v#7Uhx?r1Oo$^OTym7v)RpOhxC7Y^6E>a3G55g zGJS15u~Zw(F*xF0rK1|$-}Um9g82}+ZX9n6-OOz5=1<4>X-~$~ccC+F^%9V-1sVLz ztj=ssM>AG$W2d*YxP%soB7*N5ejXJBMzd*B?!FNQjc=WOMbYnLWXv1cjVt-PkN%)V3OOOB`Go*uVS(E)JkJYwO zp(D{mffg1^LnkOi-5oSXAS4P&~Z}W*lvVD{*>+g zmfC{gnPrd*w{083>{Nx_vVLM~s$-OFNV=3UPTxD`b-iL3%cnEhK0O-t(>h2yn0z4B z4t(Ke>rtt&&2N9R`|>| z6V4IbDDShDbg;1=hFa^`VA$(j)OJQc6W!1P2T87-LuZ^H`%XY#{i(*v_hUnmd&GF< z9>*}G-zK7p#)jnl^XrKKCUTj9!ipj#lQ}SVj%~iMv%{r-huuJUx2%rpVZ-jkivuf|KtugFkYPWxp?~j9HBc2J5hTg W8n{^y2%H8af!#5@{pF@z Date: Sat, 18 Feb 2012 04:12:59 -0400 Subject: [PATCH 2/5] Moved bulk document and user import to a separate chapter --- docs/releases/0.12.rst | 44 ++++++++++--------------------- docs/topics/initial_import.rst | 48 ++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 30 deletions(-) create mode 100644 docs/topics/initial_import.rst diff --git a/docs/releases/0.12.rst b/docs/releases/0.12.rst index 1f3563a4b2..68dba8a8ea 100644 --- a/docs/releases/0.12.rst +++ b/docs/releases/0.12.rst @@ -46,6 +46,10 @@ ACL support * Object level access control is now in place for documents, folders, tags and smart links. What this means is that administrators can now grant permissions to users, groups or roles on for specific objects. + A more in-depth explanation of how this new ACL system can be found in + the :doc:`3 tier access control <../topics/permissions>` section of the + permissions chapter. + * Default class ACL support. Administrators can setup the access control lists that new documents, folders and tags will automatically inheric when created. Aside from asigning permission to users, groups and roles @@ -83,52 +87,32 @@ the download of several documents in a single compressed file. Customizable GPG home directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Addition of the SIGNATURES_GPG_HOME configuration option to let +Addition of the :setting:`SIGNATURES_GPG_HOME` configuration option to let administrators set **Mayan EDMS**'s GPG instance home directory, used to store keyrings and other GPG configuration files. Out of process bulk uploading ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A management command has been added to help upload a large number of documents -from a compressed file. The command line options for this feature are as -follow:: +from a compressed file. For information about this new feature check the +:doc:`Initial data loading <../topics/initial_import>` chapter. - $ ./manage.py bulk_upload --noinput --metadata '{"project": "bulk"}' --document_type "Accounting documents" compressed.zip - -**Optional arguments** - -* The ``--noinput`` argument skips confirmation and starts the upload immediately. -* The ``--metadata`` argument allows specifing what metadata will be assigned - to the documents when uploaded. -* And the ``--document_type`` applies a previously defined - document type to the uploaded documents. Out of process user import ~~~~~~~~~~~~~~~~~~~~~~~~~~ A management command has been added to import a large number users -from a CSV file. The command line options for this feature are as -follow:: +from a CSV file. More information about this new feature can also be found +in the :doc:`Initial data loading <../topics/initial_import>` chapter. - $ ./manage.py import_users --noinput --password=welcome123 --skip-repeated user_list.csv - -The CSV field order must be: username, first name, last name and email, any other -column after those is ignored. - -**Optional arguments** - -* The ``--noinput`` argument skips confirmation and starts the import immediately. -* The ``--password`` argument allows specifing what default password will be assigned - to all the new users that are imported. -* The ``--skip-repeated`` tells the importedr to not stop when finding - that a user already exists in the database. Refactored document indexing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The document indexing functionality has been improved and moved from experimental +:doc:`The document indexing <../topics/indexes>` functionality has been +improved and moved from experimental stage to beta stage. Index configuration menus are now available on the -``Setup`` menu and allows administrators to create a skeleton tree that will +``Setup`` menu and allows administrators to create skeleton trees that will be populated with document links depending on their metadata and properties. -This populated tree can also be mirrored on the physical filesystem and shared +These populated trees can also be mirrored on the physical filesystem and shared using Samba or another filesharing server giving users a structured view of the documents contained within **Mayan EDMS** from the ``Indexes`` tab or from a mirrored index shared via the network. A new configuration option @@ -147,7 +131,7 @@ the need of the **Mayan EDMS** user base. Staging file previews ~~~~~~~~~~~~~~~~~~~~~ -The staging file previews now show the filename as the title for easier +The staging file previews now show the filename for easier identification and speedier upload selection. The staging files previews are now treated as a gallery which means that users can preview an entire page of staging files without having to click and close each one diff --git a/docs/topics/initial_import.rst b/docs/topics/initial_import.rst new file mode 100644 index 0000000000..72859f49bf --- /dev/null +++ b/docs/topics/initial_import.rst @@ -0,0 +1,48 @@ +==================== +Initial data loading +==================== + +Bulk document import +-------------------- + +**Mayan EDMS** has the ability to individually upload the contents of compressed +files, however by nature of being a web based application it is bounded by the +limitations of the HTTP protocol, this imposes a limit on the file size and +the amount of time **Mayan EDMS** may keep a connection open while it processes +compressed files. When the desired amount of documents is bigger than what +these limitations allow, **Mayan EDMS** provides a command line tool for out of +process document importation. + +The command line options for this feature are as follows:: + + $ ./manage.py bulk_upload --noinput --metadata '{"project": "bulk"}' --document_type "Accounting documents" compressed.zip + +**Optional arguments** + +* The ``--noinput`` argument skips confirmation and starts the upload immediately. +* The ``--metadata`` argument allows specifing what metadata will be assigned + to the documents when uploaded. +* And the ``--document_type`` applies a previously defined + document type to the uploaded documents. + + +Bulk user import +---------------- + +As well as providing bulk document import functionality **Mayan EDMS** also +includes a management command to import a large number users +from a CSV file. The command line options for this feature are as +follow:: + + $ ./manage.py import_users --noinput --password=welcome123 --skip-repeated user_list.csv + +The CSV field order must be: username, first name, last name and email, any other +column after those is ignored. + +**Optional arguments** + +* The ``--noinput`` argument skips confirmation and starts the import immediately. +* The ``--password`` argument allows specifing what default password will be assigned + to all the new users that are imported. +* The ``--skip-repeated`` tells the importedr to not stop when finding + that a user already exists in the database. From 03cdea8920b7b3cb1b8079e4b0e3039cf97ea279 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Sat, 18 Feb 2012 04:13:32 -0400 Subject: [PATCH 3/5] Add document signatures chapter --- docs/topics/index.rst | 11 +++++++---- docs/topics/signatures.rst | 24 ++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 docs/topics/signatures.rst diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 2d297d1745..a97ff7d101 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -6,10 +6,13 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: .. toctree:: :maxdepth: 1 + file_storage + initial_import + permissions + transformations + document_visualization + versioning + signatures indexes smart_links - permissions - document_visualization ocr - file_storage - transformations diff --git a/docs/topics/signatures.rst b/docs/topics/signatures.rst new file mode 100644 index 0000000000..f2cad89fc2 --- /dev/null +++ b/docs/topics/signatures.rst @@ -0,0 +1,24 @@ +=================== +Document signatures +=================== + +**Mayan EDMS** supports two types of document signatures, these are embedded and +detached signatures. When a document with an embedded signature is +uploaded, this signature is readily detected as part of the document +inspection step. If the public key corresponding to the signee of the +document is not found, **Mayan EDMS** will try to obtain it from the list of +keyserver specified in the config option :setting:`SIGNATURES_KEYSERVERS`. +Failing that, **Mayan EDMS** will indicate that the document is signed +but that it has no way to verify such signature. +Existing non signed documents can be signed in one of two way: +by downloading the document, signing it, and uploading the signed document +as a new version of the existing one using **Mayan EDMS** :doc:`versioning support ` +or by creating a detached signature for the non signed document and uploading +such detached signature file using the option likewise named menu option. + +Maintenance of the public keyring can be done using the ``Key management`` +functionality in the ``Setup menu`` + +From this menu, key servers can be queried +and the results imported. Public keys no longer needed can also be deleted +from this menu. From d51a5590f89fcbbb4305f753ccbcdf3c0ab1ea6c Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Sat, 18 Feb 2012 04:13:49 -0400 Subject: [PATCH 4/5] Updated documentation index --- docs/index.rst | 13 ++++++++----- docs/releases/index.rst | 9 +++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a28c4f98f6..b13a2291a4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,13 +38,16 @@ First steps Understanding Mayan EDMS ======================== + :doc:`File storage ` | + :doc:`Initial data loading ` | + :doc:`Permission system ` | + :doc:`Transformations ` | + :doc:`Document visualization ` | + :doc:`Document versioning ` | + :doc:`Document signatures ` | :doc:`Indexes ` | :doc:`Smart links ` | - :doc:`Permission system ` | - :doc:`Document visualization ` | - :doc:`OCR ` | - :doc:`File storage ` | - :doc:`Transformations ` + :doc:`OCR ` Between versions diff --git a/docs/releases/index.rst b/docs/releases/index.rst index bd3fc2ddd6..3bbee2aa57 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -11,18 +11,15 @@ all the backwards-incompatible changes and deprecated features for each 'final' release from the one after your current **Mayan EDMS** version, up to and including the new version. -Final releases -============== - -0.12 release ------------- +Latest version (0.12) +--------------------- .. toctree:: :maxdepth: 1 0.12 Historic changelogs -=================== +------------------- .. toctree:: :maxdepth: 1 From a510cfe6d0db946da9b81d0a188e8252a6e27bb4 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Sat, 18 Feb 2012 04:19:56 -0400 Subject: [PATCH 5/5] Link features to the actual chapter where they are discussed --- docs/intro/features.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/intro/features.rst b/docs/intro/features.rst index 43e9bfa267..71d19c1dd9 100644 --- a/docs/intro/features.rst +++ b/docs/intro/features.rst @@ -2,11 +2,11 @@ Features ======== -* Document versioning. +* :doc:`Document versioning <../topics/versioning>`. * Store many versions of the same document, download or revert to a previous version. -* Electronic signature verification. +* :doc:`Electronic signature verification <../topics/signatures>`. * Check the authenticity of documents by verifying their embedded cryptographic signatures or upload detached signatures for document @@ -56,11 +56,11 @@ Features * Automatic linking of documents based on metadata values or document properties. -* Roles support. +* :doc:`Roles support <../topics/permissions>`. * Users can created an unlimited amount of different roles and are not restricted to the traditional admin, operator, guest paradigm. -* Fine grained permissions system. +* :doc:`Fine grained permissions system <../topics/permissions>`. * There is a permission for every atomic operation performed by users. @@ -68,7 +68,7 @@ Features * Multiple page PDFs and TIFFs files supported. -* Distributed OCR processing. +* :doc:`Distributed OCR processing <../topics/ocr>`. * The task of transcribing text from documents via OCR can be distributed among several physical or virtual computers to decrease load and increase availability. @@ -76,13 +76,13 @@ Features * **Mayan EDMS** is written using the Django_ framework which natively support Unicode, this coupled with the use of text templates allows **Mayan EDMS** to be translated to practically any language spoken in the world, by default four translations are provided: English, Spanish, Portuguese and Russian. -* Multilingual OCR support. +* :doc:`Multilingual OCR support <../topics/ocr>`. * As supported by the OCR engine tesseract. * Duplicated document search. -* Plugable storage backends (File based and GridFS included). +* :doc:`Plugable storage backends <../topics/file_storage>` (File based and GridFS included). * Very easy to use 3rd party plugins such as the ones available for Amazon EC2.