From bcdc419b66a649ac74b9507af6b0ba3a6bada187 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Mon, 2 Apr 2018 00:34:08 -0400 Subject: [PATCH] Update documentation and logos. Signed-off-by: Roberto Rosario --- docs/_static/logo_pyramid_only.png | Bin 0 -> 2931 bytes docs/_static/mayan-pyramid.svg | 114 ----------------- docs/_static/mayan_logo.png | Bin 0 -> 5705 bytes docs/index.rst | 14 +-- docs/releases/3.0.rst | 193 ++++++++--------------------- docs/topics/pending_work.rst | 6 +- 6 files changed, 59 insertions(+), 268 deletions(-) create mode 100644 docs/_static/logo_pyramid_only.png delete mode 100644 docs/_static/mayan-pyramid.svg create mode 100644 docs/_static/mayan_logo.png diff --git a/docs/_static/logo_pyramid_only.png b/docs/_static/logo_pyramid_only.png new file mode 100644 index 0000000000000000000000000000000000000000..4a09190392d128addd228a3e136308399c4d76ef GIT binary patch literal 2931 zcmV-(3yk!MP) zaB^>EX>4U6ba`-PAZ2)IW&i+q+O<^KZNo4O{nr#7K|FML9LJV`ZqV`jNK2_5G(}pV zBrMX83{N?seZ2SZW|Ws2G?ki{oFhmVU3i63<3Xn1@GzeJfNGADC@y|Fg(ctNi=oJX z`HD|T>q8(N+39vQOq}aOAU=dx0_dc(qM?ug{w6cpFHyhV*O8!)PI5__Ye^yRnK_DZ z6UI}IY!Zbe$qH#FTNXzRDSn!#2SfIPisGn9%#j6?TF49&_XcE4{)BrfGhkR2D?GLm z`7q4)`!eK;&t*&sUY@`#r(pT}&HS{O@Y80zt<#`YhsIYN9aA`$*ZW?3Z|AwS& zj#ifN31v4bhL}sf3jhEB1am@3R0s$N2z&@+hyVZyaY;l$RCt{2ookF;RTY50xt*bq z62Mv_eNjbGqYxch6is~m&=673v_YeZiHV68jXyB{P!k@}M1Lspm8kKDVvHIiC=F>) zK|vCMQp8q7g=s1jW}uaHhEhAzPG_z^*15U+oVkzl*spW$`jV6Eot(4xy63FB_u6}} zy*4Oi_&zWXvvq>aRPoDmgjcF|B1hvHB^xW2 zZa)?|oH9y^rFcXYOL2lKmf{3eEX4_`Sc(%=u@on$Vku5g#ZsK0ilsO~6-#k~Dwg5| zRV>8`s#uB>MoF>Sp#?~YMGmKol49K(T7ZODb(}W!(X98COs|q}GA8<5DuLIs`StfwHkoXP&n}N#zP@E((kSElg3sr@wi|VPqQvtDfSr}zj#7$Mz+)8uU`K$}MmgUsQAVEY3q~Dp z0G3LW@mFd(iCs&f6E*>tlz48MbQiPHjyNkY%Y70!T%wFOBHd{1sPoKwS^MzWOnxsg zQ&E;)JZ_{Rf7)DEt*VwEMUSOfUzeGlswmF2v z(&~6KWEHy6)Y--=%ON9u1#XlIq}$tKy8a(kpYOdY&qFMIX9C*SN2?+U6#x5cl{_+??KDuF9Fx&d8s~$)p-9P_GQbC$XvP0 zWZ96(+g{pf0asftvof(7?=IHwOvP#;|MdM1>d7*Z$xl0|<17bdRw7o#a)H@WEF(Lj zL(9=vMoF;_8tLu87d_S60zL&in&e%ySkW;minV|&0(ZECV!LLlayeba`nSh=gAuFo zZkrj>KId73+BIf;>CFy@5 zBg3lQ@lj+^`^Oc_u};k14IuWAjpd3tBYh_BwtNlZ1aK-zw}5jjlsQkN5otoSSYyDo zq$9q#P!$t3<=Jj@R` zi9L_hqHG|&qsaGS^jVY(`&5cpM};rks~v=Gu~yMltbYJ6Ai;GTN31jNw#eEsp~Eh2GSUmUi6j^W zO;@a}9kZ$DUH-_9NE_=-ItpE3hZfBdI+^KE18Wo38ZiWf+S#13s=buhzI?!lig)d^sqr@Fi= z);{2O_<5N#_&F$`D5ip!Jy@V9OUQfwyN9}fFkRseWDEVJj_Y|olm8>>7AzE|)8T30 z8^9We^|g^d^lpcBtiXjo*2`JBtvm$BNl%W3aFyxB67XLme=c!skv~QEM6}A-RIIJQ zSAlonHvD22eBL6}S;O9I6sFyTZ={@3UB5 zRSp>Gx8b(CDZ+ZhfbYn6kU0K`XCU#&Uc`c;+ce&NZdo7367Zmre|0E9dN5A4kZ) zz*EQwHkNrdD>PNHvTJa=@#sC7gL~2s+Yr&vvGvCQawn~|VvK7)V^V;pz|-9>0stQxRLI(pyT$rUqG z!*8hb7f$VvssoZCs#-D9n>saU?;VTLhHy4%}=+mlqwVn+FU z4w)i(RUlbR=7--h9Gk}bpDmVEg{-|2>o7hW2Q?Nu%gT4O*<#&{coV#xu#3Is2Gthw z4}7rCy&=h-I<_C#9u|s4;4jGHy`scPUbmTxfX@)uVs0-cfE(!Ue!dde8BUymw1AuF zx(jayJ|0e-+)N>1p(-z)k0J4uLWKS)dM%Ki480)&nFd|g8M0m#fjoJyM;Ov5a^KcDzRN_NPOthQj$-PQr-l*3Wv zk8yDzS&A^mkY%!_O^{|4>uTa&56zAYr>Tcx4W-G7wFWshcd^gCF|Y`H)X2v&msOdj zDVDiqeUb=|w9Rk~2{%5Qd&I-3kpV_yXAwN7K#*vWR zov=%Lh+Fn4;Cs}g7gH2PQ4~c{6h%=KMNt$*@lVK|xBZwvPC-3RH{9bI - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/_static/mayan_logo.png b/docs/_static/mayan_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..28f0bbb006de13fb4a00ab6333796efce0588783 GIT binary patch literal 5705 zcma)AS5(tau%;IkkX}MFq7>;$Z;GM!@(YpPktQYdjtGR%1f+?8AT<;Tf`EVoLsLqW z4u)Pusu)8ka{b@8`*vr~%TOaT;aJwMn=Y zp`ntVPrTtSPX2C^et{lE`>H%-Wb6ZakO!7wul9<=C)uWQF|nNL_j}{o-_UXO6>z<2 z*JfFhm0WwOts68s()TzBuT2X#yqCeV*4HO=`)DKOsd8Q4u#^;yI3!J<+14D5N{z5GQ>_Pl#p|M#%@ zk5(dJZ}KzBXbVUY3MJ5f0wP-)de9PS8C*E*0(abE3(%n4x0o`4Kd)1&@%kPUXAxHj zvr_-zAtya;;9~yeL{EdYOEshR=3m3*KB&f8godvTJ5twS8R8i9rRHjUe)sXHEGvp- z$q&m~pjqv7&%X=NvZ3N-P{xOimzrVrds2h^Y=Axwa-igx%o>o#Y|bGjZ09@DfrD+* z_p)Q*_;7|VEd2((@u-;FV0e6s!Oui_JEes&Bp~I~|B||^@S(bZ&U&W>BZ)2Bz5xbq zruV-)rFJ|u?8D4mxd3-}O5A_^UplFG-D_{NGtJ|H$eZ2AN&)05S&LP$x+ZzxehEME z)CmcaR*`fR9{-N|M2)$25XJ28l0k}I<-4Q?o$RvXx~$H1GdoZpzNqwEZ5JLq&kG;) zbLz%1D{WeFMHD$Fepkwg=L;M;;9o8xL!rRG4Ut5XWl)x2 zY4~%}Of^>c{1Bp>sDh?PUzuP`VKc=VjOU^cRH;iSB!~4H@uI$q27zTwxAG8%6pU0! zt}oVQfd#C=CD^evZM<>72z9EGzh$~iK5nDjho&p2M+9{X}@`F44X zssaSxF)YJQ*U@ogwtii5Mn&5T*h^I_j9XusjzfK)A4JHU?jh6#u3 zMHf$1O*(N<))=>hkK}yW1NE~LW4Q8865SkQ&tNgh@>9%F#nHj>ae`;GK8~7gMJ{&K zQT*_^N=XLc8mJ*d19Q9et*>vMyrr8hsj+eEls>!*ma<8q%1OL$;uhJ-?1A2)rzkM2!FJX^|h|r zGA$$;k!`Igi|oLoMK1GS7PMU!vShpbdnS8o{1p008pKt&eqnMXD!MKy_;E>xVL{VO zf%_QuAM!u!S*lh-grTOwv`W%#{=Zjw4MI3-J?AVT=j>XeC296Wr+D=#EwjkPN57ti zs!|>|&WJ%H2Kn}cDkj*yWe(FqKe9Fjr@E5QGKcl?X_!ekc24|2%2@#yGIc2}@B4NP z+MK%)9S!)`!K>>!W;%=S!1xT$*6;l*|B6>qSit0I;_C_aJNOK4er{Cwv&afQZ=?Am zz{!7EyVFLEfW8-GF9t1I&4*#**&A5;zL`L1>UNU%yIdlZitAzVmkDw77(W}KRGbZ_ zc)#7H`&_Owogk!Em(T@6Y_Swgx4or^BEHC+P_;o-hSfD6SJfgbQ8)_X_^V{4w|XGz zihirZ2n7z^VX>*OhNtSx(|`Z?v^26A6|_!ds3(Y{zbc7GmWHzWs;beRe_5hZPwvtF;z-M zLF{iHx2n)C5DBW_$(1CxOi6M#OVepW|6haHZg)tf)rk zhnNe<`KIN?>6UU?{$A)}tSbCnt<7ETuK~!Z+FR4&2VwA$AJ$pW%@A_Xgc`k_7!=gR zf{QFgsmDn?l#;#cMe8Z0Y=&O!{l4}HB1z5or10L6Z8eJX!;q#IVKtIeBn3Vm3UP^#cm!3^^=Ulp@Z7-Li+U-j@6xu4?A8D8 z<)=-giTBqY@3|hlq(+U6MRTjQsfbdn*bSCo^O9SUxtL3eeAg^k*#cK?i&V-#DkrJ> z%l5w zWyOU!ZBlr1sSQ~nD%$v$t6CG;FQE(7#JWA60GA-Trs${sT8<^CG2)m__pc6)n88)4 z7Tf@Z%Cfv!=1o1I{l;i0jg8bw$&~JhiH8|CH*d`j?UNxV!>b#5NK==W^%FF@SfpHu zGcGwPG70X<)Q{2|6w5asG{#YX2yo(7& zrzYs_Z~1=f6EjY|dDwxu_`5~L^K^>oH(??B0c=xIRXkTl-f{@0IA3t)rmvQ-_B`kN z?9N)@E-k*^RKb_TTSD{KQsVw7$`k+~w<#{~2k0c8nRa+Ak$IgTQhZD7SZBmbsu`o* zO3BYtr<>Zu_Wt`FnJ4pn8%okU;j;O6S~l&HoD}7Cqz0ikYRm1ff2R z*nyrIiM*xaNP@1uV7pG9fi(;Z?Va9`$RJ(wCrUB;-pWoF+zda+#~c+9yEh879>*>l zSW0SK(iLpmvgNW}@5OIb9NqoP;%_;9){GcJW8_53U)7>|#>|tlcefLip6X)dF-G8Q zf;BdP9y>}ELuQ*7@b?xs7-Nlz!B{ozJh|~6OoWIrTwtRtfP*g(x-6NnB2KMC=|dey zBx(%B(pVwbXRUx3q8rKgc;#KJ0t7qX)g|iwY~|_87O

MPbPn;`M|wq2TG`N80YcIg{|cCYQ1TE+StpXZc7FUrWru!cD9>|1x%XP zzvfXcJhA^?Ha6qo1zCUF)H_#gNigzBCW;{U^_qkr5{Yz4AbX0xh1+h9SZP{b!Xca( z-F=n;SLLYozeQa+ZM$-xsOA6&FlTkgyMRCWQdZ3G1CWra$cg^@0qSXVD9jztapQv6 zSimkzdiUe(=61BqMlAbxbgRbZp5kn`_dm)=(R*{%CVN^3;FLEAks7;SzrI8rxhUmw zAa~@&!#u|{OZENrimzepNA1uYPdRD60=wbMZD2OlZl;)N5O0$lZN3N_&i91OUv920 z{;)eUhRhpGRN38JQZFz;C1OHZpB*IoS{C*xY?(VABkqk|O^jsxu5lDXR0EgodXrz$ ziBtU1C3OlQpNF!)XNg>+I#SR*xyBau7V3=aj7#YD?m;m7+ad*&t{3UXfMB@J7@rbk zqHm$foIxb?Q3tH8|pZB;8g z{V!Ej?LWRdQ5@Cb2h*2bw7WTiF%Cqvl0&nO$-peFSNMLx|i**Of-GjsUR+yCIm z*?cd#E5S_6_-uxLpBb)1XklWi@~}CkbhOM>>@7(#i08A|;_= zV?^XsPWxj|_dA{ac!3KpL~|m~wO6J$M|`lH*0yTAKe!51x&zaTAQnA9s1dQDI-(K3w z&jA5Z{8g!{buxZiM#mb@X&J2F*FAHyF_;_#=t+rwAFw_6r2nktRZ{L(^~e<6$wkCk zlSgLkzvoUCQ!wi=}?|CTW9eV^VT&~`ce zP-Z2TM%Df%PKo)4)@EtB+Bbnn8HKQ!0n<6Uw{shrdMc{wzpvPP&{`m;Frhn!u`LEf ze8KxsFUM--3HABP0CD+YmZ>K(G+aEav4RUXX^SlJb=f~S>{pi>SoYCe8>gBgwwzG# z#p{90=zHLXrF%6n;f|nz#KtrIBgbM-KO>w|8Y{j#IF5RMBNKJ^VyPp)Enxe@C2d#v zSc_EXkx9Uo3X9r{Af__@sO^iMrL~A$L)r)?ALm^E$bOOO(K3Gz$2Gw$iinlQ6y2X_ z8up*;^_-mii|wi}a3R4}u@I4B62^g&w&U1)$1s%7N05|=h-3;QMQheQu-Ggvmv9 zTdzg?EyMRuF2q*I#%_N|4(mEoX9ayWSrxo|hwx7SeIzrhn^!h%CUeE`r|sE z6}vT1O7kSOoe<4jn7|;iSSEA#lKE+prz`f*v3F3=XKr2s99WCsO?hN>;{MGJQxd#+ zyaYKQa~R!K=1@>)zh)QJPx$(TH7iwX-R5_Y+{X??MX(0H$Qb630Vt+9XPEv$zfFt3 z4PH8K?AFBbyG^0KzP;UOWLlpgH2>>CN+BUr&qLFYhtP6EK10s{jZ)HI>;%;?dT3XK z1{8bl*=zmLD(H+qBp8@)2IQrN0=d#Q&eL2m>UHrCi#64eqL2GC>ZbI?m&7}&5^GQ& zwa&rgpHVyji`J3-2q8khff7&jTE5~lvIQ#m_2k(c$Hi^7EkTb^D3e(uZH$A5b^Pvd z6S_?ez4Q_`FUzchTfWu=w~`1*ONztxo^84p3X=@b5G7 z?mLS1xgJ!7TC}~noA#AtFM50hVJ+|o_fc`n5$A-owh?9l?DTPfWn|Tm@b-(Tp#0Y; zCKs$&fbRg(EiMar3;d=DEa_;s4E3V>n$JGflE+FqwGbr4Stm+SLH5 zC}AimuYzaS2U#Z|u2ps_Ts(d%5__#UR;_L{nmw&}<0(SkBl5ibkBv@)> zBB6f0j^CR(Mh}PD0nx8g?+U=9Bbk+?QUX(l;)4#X3i|A0>=o(j177C!GtZ2FxS>b` zdKvH9oNQ1}XiAD@dAhi4{p`E0OwCT^EGDqv+e+L6K4r3^)3D-`2+Q~cugQLjuIvK93~Cx7ga*giU2SeMN#U{!c4%(Q zdjEyfQ^jPhb<%Blh^2Sl8l%+M3EP35H0uow9PwzRxmUk|Rr>7MOKLK9x#!dT4VIjv zMi>@O{q-%9zmTyq{n&Aw2&>JV z?257*amM2OYC=mLrjIlea2tT^BCBH6my2%D(99+8=6LG6jXxSX&s@Wlo%l7sue2=D`Cq z?%j$sXI2d4+T^`3Js%S@pn6~de$M^#!VrT>4MlgKCAFVBVD(c8=tso#ZTn%`Kjr)b zo1(qD+k;MfNlbVTdiextKDczKiEa|SNq*F{zL>!Ho-8zNm>4|5B{?q3W@CFq@ke-W zaD&Ju&oMLex%*!Sw{Prq=nxKdX-x`imI@72r8Vr;7a+3?PDB`%M?Mc^gtDjm2hemZ zMbYM_p8>|3y|b@3!Sy?PfjCbAVQh{}AoMkALd%u+{R=;#MUjh3%CFN3EfRkV(*BKo O$@H|0A&r`jPyYu_Xysr4 literal 0 HcmV?d00001 diff --git a/docs/index.rst b/docs/index.rst index 8fda4edbcd..06529009a3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,13 +1,9 @@ -Welcome to Mayan EDMS NG! -========================= +Welcome to Mayan EDMS! +====================== -Mayan EDMS NG is a modern fork of Mayan EDMS focused on stability, -perfomance and new features. - -.. image:: /_static/mayan-pyramid.svg - :alt: Icons made by Freepik (http://www.freepik.com) from www.flaticon.com is licensed by CC 3.0 BY (http://creativecommons.org/licenses/by/3.0/) +.. image:: /_static/mayan_logo.png + :alt: Logo is a trademark of Roberto Rosario :align: center - :width: 30% Mayan EDMS is a `Free Open Source`_ `Electronic Document Management System`_, @@ -35,7 +31,7 @@ repository for electronic documents. FAQ Contact MERCs - Pending tasks + Pending work .. _Docker: https://www.docker.com/ .. _Django: http://www.djangoproject.com/ diff --git a/docs/releases/3.0.rst b/docs/releases/3.0.rst index a370f2c35e..822913b8b1 100644 --- a/docs/releases/3.0.rst +++ b/docs/releases/3.0.rst @@ -1,6 +1,6 @@ -================================ -Mayan EDMS NG v3.0 release notes -================================ +============================= +Mayan EDMS v3.0 release notes +============================= Released: March 19, 2018 @@ -10,24 +10,12 @@ What's new Turning Mayan EDMS into a single page app ----------------------------------------- Historically, Mayan EDMS has steered away from adding too much Javascript -in its code. Roberto, the main developer, often explains his rationale -for this decision. His goal has been to maintain a robust, backend-based +in its code. The goal was to be able to maintain a robust, backend-based page rendering method that will be as future-proof as possible. This approach comes at the cost of some page loading speed, and reduced user interface interactivity. -The Javascript ecosystem is an untamed jungle of competing “standards”. -Between JQuery, Angular, React, Ember, CoffeeScript, ES2015, ES2017, -Babel, Grunt, Gulp, Bower, Webpack, Vue, Webpack, Rollup, Parcel, -among many others, is easy to see why that approach was the correct -one at the time. Luckily things have improved thanks to HTML5 and CCS3. -The browser can now do many things that often required convoluted -Javascript code to achieve. - -One of the most common complains about the user interface is that it -is slow, heavy, requires users to move around too much. That it -requires “too many clicks” to achieve things. - +The whole system has been update to work as a modern Single Page App. Single Page Applications (SPAs) rewrite the current page dynamically rather than loading the entire page on each click of the mouse. This makes the web application feel and behave more like a desktop @@ -38,13 +26,10 @@ response time to user events. Because the style is loaded and interpreted at the beginning, the browser is also able to apply it to the new content faster. -In order to strike a balance with Roberto’s backend heavy philosophy, -we stuck to using just HTML5 and jQuery. Aside from two additional -jQuery libraries, there are no extra framework dependencies. With the -conversion to an SPA, many other petitions for user interface -improvements are now possible. We will work on these once the community -confirms that all the user interface changes made to create the SPA are -working as expected. +This redesign was achieved using only HTML5 and jQuery. Aside from two +additional jQuery libraries, there are no extra framework dependencies. +With the conversion to an SPA, many other petitions for user interface +improvements are now possible. Upgrading to Django 1.11 @@ -57,89 +42,18 @@ Mayan EDMS uses a complex template, form and widget system. The system mimics object-oriented concepts like inheritance at the rendering stage. This allows the more than 300 views to be serviced with just a handful of forms classes and base templates. Testing and auditing all the views -and forms after the upgrade was a lot of work. If any member of the -Django project is reading this, please adopt stricter version numbering -convention, something like Semantic Versioning. +and forms after the upgrade was a lot of work. -Along with the upgrade to Django 1.11, we fixed many deprecations -warning in preparation for an eventual upgrade to Django 2.0. +Along with the upgrade to Django 1.11, many deprecations +warning were fixed in preparation for an eventual upgrade to Django 2.0. Notification improvements ------------------------- -In version 2.8 we introduced event notifications. These work by allowing -users to subscribe to a particular event like Document Uploads or to an -event of a particular document like when an invoice is edited. If -these events occur, the user gets a reminder next to the bell icon in -the main menu bar. This feature had one important limitation. The -notification reminder would only update if the main page updated. That -meant that if the user didn’t interact with the user interface they -would not get a notification reminder. - -We implemented a simple mechanism that checks for notifications -periodically without user intervention. We avoided the use of webworkers, -websockets and push notifications. The result is almost instant -notifications without user interaction and without adding any extra -dependencies. - - -Notification improvements -------------------------- -In version 2.8 we introduced event notifications. These work by allowing -users to subscribe to a particular event like Document Uploads or to an -event of a particular document like when an invoice is edited. If these -events occur, the user gets a reminder next to the bell icon in the main -menu bar. This feature had one important limitation. The notification -reminder would only update if the main page updated. That meant that if -the user didn’t interact with the user interface they would not get a -notification reminder. - -We implemented a simple mechanism that checks for notifications -periodically without user intervention. We avoided the use of webworkers, -websockets and push notifications. The result is almost instant -notifications without user interaction and without adding any extra -dependencies. - - -Migration squashing -------------------- -Database base migrations are a must to ensure your data remains coherent -after each upgrade. They need to be committed sequentially to simulate -the evolution of the database structures over time. This is true even -for new installations with no existing data. As Mayan EDMS matures and -adds features it also adds migrations. Each of these migration add up -to the amount of times it takes to install Mayan EDMS. - -Django recently added support for merging migrations. Because migrations -are sometimes interdependencies between each other, this is a delicate -procedure. Instead of getting wild with merges, we used the feature in -moderation. We merged the migrations that have proven to be stable over -the course of months or years. Additionally, these merged or “squashed” -migrations are only used for new installations. Any upgrade of an -existing installation will use the normal migrations. After some time, -if not issues are reported with the merged migrations, the individual -migrations will be removed and the merged migrations will take their place. - -These are the apps for which migrations were merged: - -- acls (ACLs): 1 and 2 -- checkouts (Checkouts): 1 and 2 -- common (Not shown in UI): 1 to 8 -- converter (Not shown in UI): from 1 to 12 -- django_gpg (Keys): from 1 to 6 -- document_indexing (Indexing): from 1 to 5 -- document_parsing (Parsing, “Content”): 1 and 2 -- document_signatures (Signatures): from 1 to 6 -- document_states (Workflows): 1 and 2 -- dynamic_search (Search): from 1 to 3 -- events (Event): from 1 to 4 -- linking (Smart links): from 1 to 5 -- lock_manager (Not shown in UI): 1 and 2 -- mailer (Mailing): from 1 to 5 -- metadata (Metadata): from 1 to 8 -- motd (Message of the day): from 1 to 5 -- permissions (Permissions): from 1 to 3 -- sources (Sources): from 1 to 16 +These work by allowing users to subscribe to a particular event like Document +Uploads or to an event of a particular document like when an invoice is edited. +If these events occurs, the user gets a reminder next to the bell icon in the +main menu bar. Dependencies upgrades @@ -169,12 +83,9 @@ their latest release. Search syntax ------------- Searching without using a specialized search database is difficult. -Most software just take the lazy route and force the user to install a -dedicated search engine. Early on we noticed Mayan’s design called for -avoiding a separate search engine at the cost of some missing search -syntax. The OR and the negative term support is our first attempt at -adding special syntax to Mayan’s search code. If we get good feedback, -we plan to add more. +Mayan’s design calls avoiding a separate search engine at the cost of some +missing search syntax. The OR and the negative term support are the first +attempts at adding special syntax to Mayan’s search code. By default now, search terms are routed to an “AND” query. That means that a search for: @@ -188,7 +99,7 @@ opposite choice we added an “OR” syntax. Searching for: will return documents with either tag attached. -We also added support for literals terms. +Support for literals terms was also added. Searching for: @@ -203,16 +114,16 @@ and “slow car”. To search for exact terms enclose them in quotes: This will return only documents with the exact phrase “blue car”. -Running multiple instances of Mayan EDMS NG -------------------------------------------- -If you've ever tried running two instances of Mayan EDMS NG, you would +Running multiple instances of Mayan EDMS +---------------------------------------- +If you've ever tried running two instances of Mayan EDMS, you would have noticed that they both try to create a lock file in the /tmp directory with the same name. Only the first instance will be able to run. The lock filename needs to be unique to each instance, yet predictable so that the workers of an instance can also access the same lock file. -We solved this issues by using a hexadecimal hash representation of the +This issues was solved by using a hexadecimal hash representation of the installation’s unique SECRET_KEY setting. The use of a hash makes reversing the value in order to obtain the SECRET_KEY impossible for all practical purposes. @@ -220,16 +131,14 @@ all practical purposes. Display resolution settings --------------------------- -During the template work required to upgrade the version of Django, we -noticed that display sizes (display, preview, thumbnail) were specified +Display sizes for document display, previews, and thumbnail were specified as a string that included the horizontal and the vertical resolution separated by the character “x”. Using an “x” character to separate -resolution elements is not standard and didn't felt as well planned as -the rest of the project. The converter in Mayan EDMS NG also allows -specifying only the horizontal resolution. This design created some -ambiguities in the code. We decided to split the settings for specifying -resolutions into two settings for each size. One setting for -horizontal resolution and another for vertical resolution. +resolution elements is not standard. + +This version splits the settings for specifying resolutions into two settings +for each size. One setting for horizontal resolution and another for vertical +resolution. The settings are now: @@ -322,15 +231,6 @@ This will cause the tags assigment step to not be assigned to the upload wizard anymore. -Repository location -------------------- -The code repository for Mayan EDMS NG now lives at: -https://gitlab.com/Mayan-EDMS-NG/mayan-edms-ng - -A GitLab group was also created and all projects will now live under -that unit. - - New upload step --------------- Using the new ``WizardStep`` class a new upload wizard step was added @@ -345,17 +245,21 @@ On some devices the height of the pages on the document preview view were squashed. The CSS for this view was updated to fix this issue. -Page number summary -------------------- -The page number summary has been placed back at the bottom of the -carousel pages in the document preview view. - Orientation detection --------------------- After reports that it is not working in 100% of the cases, the feature that detects and fixes the orientation of PDF has been marked experimental and now defaults to being disabled. + +New proposal system +------------------- +The Mayan EDMS Request for Comments or MERCs will be use to propose and or +document the new features, the existing code, and the processes governing the +project. MERCs 1 and 2 have been approved. MERC-1 outlines the MERC process +itself and MERC-2 documents the way API tests are to be written for Mayan EDMS. + + Other changes worth mentioning ------------------------------ - Add Makefile target to check the format of the README.rst file. @@ -420,12 +324,17 @@ Other changes worth mentioning - Add view to show list of events performed by an user. - Allow filtering an event list by clicking on the user column. - Revise and improve permission requirements for the documents app API. - - Downloading a document version now requires the document download permission instead of just the document view permission. - - Creating a new document no longer works by having the document create permission in a global manner. It is now possible - to create a document via the API by having the document permission for a specific document type. - - Viewing the version list of a document now required the document version view permission instead of the document view permission. - Not having the document version view permission for a document will not return a 403 error. Instead a blank response will be returned. - - Reverting a document via API will new require the document version revert permission instead of the document edit permission. + - Downloading a document version now requires the document download + permission instead of just the document view permission. + - Creating a new document no longer works by having the document create + permission in a global manner. It is now possible to create a document via + the API by having the document permission for a specific document type. + - Viewing the version list of a document now required the document version + view permission instead of the document view permission. Not having the + document version view permission for a document will not return a 403 + error. Instead a blank response will be returned. + - Reverting a document via API will new require the document version revert + permission instead of the document edit permission. - ``Document view`` permissions is nor required to view the details of a trashed document. @@ -458,7 +367,7 @@ Using PIP Type in the console:: - $ pip install mayan-edms-ng==3.0 + $ pip install mayan-edms==3.0 the requirements will also be updated automatically. diff --git a/docs/topics/pending_work.rst b/docs/topics/pending_work.rst index 1e77a9911c..7385124ddf 100644 --- a/docs/topics/pending_work.rst +++ b/docs/topics/pending_work.rst @@ -111,8 +111,8 @@ Other PasswordChangeView, PasswordChangeDoneView, PasswordResetView, PasswordResetDoneView, PasswordResetConfirmView, and PasswordResetCompleteView. - django.utils.translation.string_concat() is deprecated in favor of - django.utils.text.format_lazy(). string_concat(*strings) can be - replaced by format_lazy('{}' * len(strings), *strings). + django.utils.text.format_lazy(). string_concat(strings) can be + replaced by format_lazy('{}' x len(strings), strings). Found in converter/classes.py and metadata/forms.py. - Fix warnings in preparation for Django 2.0. - Update all tempfile.mkstemp() to tempfile.mkstemp(dir=setting_temporary_directory.value) @@ -120,7 +120,7 @@ Other - Update common.utils.copyfile to use only file objects. - Change metadata label column from CharField to Label - Start testing to Python 3 compatibility. -- Unify all **RelationshipForms into a common class. +- Unify all RelationshipForms into a common class. - Add test for event subscription view. - Repeated templates: password_reset_confirm.html and password_reset_form.html - Remove unused text=get_notification_count from events.links