Reorganize documentation into topics and chapters. Add new material from Wiki.
Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
@@ -1,6 +1,5 @@
|
||||
==============================
|
||||
MERC 1: Purpose and Guidelines
|
||||
==============================
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:MERC: 1
|
||||
:Author: Michael Price
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
==================================
|
||||
MERC 3: Using javascript libraries
|
||||
MERC 3: Using JavaScript libraries
|
||||
==================================
|
||||
|
||||
:MERC: 3
|
||||
@@ -17,13 +17,13 @@ MERC 3: Using javascript libraries
|
||||
Abstract
|
||||
========
|
||||
|
||||
This MERC proposes a standard way to use javascript libraries.
|
||||
This MERC proposes a standard way to use JavaScript libraries.
|
||||
|
||||
Rationale
|
||||
=========
|
||||
|
||||
Mayan EDMS uses several javascript libraries for user interface features.
|
||||
Currently, the libraries are not installed using any javascript package
|
||||
Mayan EDMS uses several JavaScript libraries for user interface features.
|
||||
Currently, the libraries are not installed using any JavaScript package
|
||||
manager but copied uncompressed. Installing the libraries in this manner
|
||||
carries some disadvantages.
|
||||
|
||||
@@ -32,7 +32,7 @@ Motivation
|
||||
|
||||
The inclusion of the libraries in source form is required by many licenses
|
||||
if the library is not installed by a package manager in distributable form.
|
||||
There are several disavantages with the current approach:
|
||||
There are several disadvantages with the current approach:
|
||||
|
||||
1. Having the library in source form means that the entire weight of the
|
||||
library's size carries over the overall size of the Mayan EDMS distribution files.
|
||||
@@ -42,7 +42,7 @@ There are several disavantages with the current approach:
|
||||
installed in the project and manually searching, downloading, compressing
|
||||
and adding the files to the repository.
|
||||
3. The source form of the libraries includes normal and minified versions
|
||||
of the code and the accompaning CSS files. There is no define preference
|
||||
of the code and the accompanying CSS files. There is no define preference
|
||||
and through the project both versions of the libraries are loaded
|
||||
interchangeably. Using a packager manager the minified version would be
|
||||
used of a pipeline to minify the installed libraries should be added.
|
||||
@@ -58,10 +58,10 @@ Specification
|
||||
|
||||
Changes needed:
|
||||
|
||||
1. Python based javascript package manager. Alternatively a Python wrapper
|
||||
for a javascript package manager could be used.
|
||||
2. Package manifest for the javascript libraries used.
|
||||
3. Installation pipeline to install the javascript libraries during the
|
||||
1. Python based JavaScript package manager. Alternatively a Python wrapper
|
||||
for a JavaScript package manager could be used.
|
||||
2. Package manifest for the JavaScript libraries used.
|
||||
3. Installation pipeline to install the JavaScript libraries during the
|
||||
installation and setup of the project.
|
||||
|
||||
References:
|
||||
|
||||
@@ -42,5 +42,5 @@ issues regarding Google, reinforce the need for a self hosted solution.
|
||||
Specification
|
||||
=============
|
||||
|
||||
Platform choosen was phpBB. Factors were: written in PHP, ease of installation,
|
||||
compatible with several database managers, mature, extersive development history.
|
||||
Platform chosen was phpBB. Factors were: written in PHP, ease of installation,
|
||||
compatible with several database managers, mature, extensive development history.
|
||||
|
||||
+10
-10
@@ -1,6 +1,6 @@
|
||||
=====
|
||||
*****
|
||||
MECRs
|
||||
=====
|
||||
*****
|
||||
|
||||
Mayan EDMS Request For Comment documents index.
|
||||
|
||||
@@ -17,9 +17,9 @@ Accepted
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
0001-merc-process
|
||||
0002-test-writing
|
||||
0003-using-javascript-libraries
|
||||
../mercs/0001-merc-process
|
||||
../mercs/0002-test-writing
|
||||
../mercs/0003-using-javascript-libraries
|
||||
|
||||
Draft
|
||||
-----
|
||||
@@ -27,7 +27,7 @@ Draft
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
merging-roles-and-groups
|
||||
../mercs/merging-roles-and-groups
|
||||
|
||||
|
||||
Type
|
||||
@@ -38,8 +38,8 @@ Process
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
0001-merc-process
|
||||
0004-support-forum
|
||||
../mercs/0001-merc-process
|
||||
../mercs/0004-support-forum
|
||||
|
||||
|
||||
Feature
|
||||
@@ -47,5 +47,5 @@ Feature
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
0002-test-writing
|
||||
0003-using-javascript-libraries
|
||||
../mercs/0002-test-writing
|
||||
../mercs/0003-using-javascript-libraries
|
||||
|
||||
@@ -30,7 +30,7 @@ overheads without providing advantages in the day to day operations.
|
||||
|
||||
In reality there is almost a 1 to 1 correlation between Roles and Groups.
|
||||
Other permissions systems already use Groups as permission units without
|
||||
disavantages. An example of this is LDAP and its commercial counterpart
|
||||
disadvantages. An example of this is LDAP and its commercial counterpart
|
||||
Active Directory.
|
||||
|
||||
Motivation
|
||||
@@ -43,7 +43,7 @@ favor of using a native Django model for the same task.
|
||||
Merging the Role and Group models will also provide a speed boost in every
|
||||
permission check and queryset filtering. These checks are nested in nature.
|
||||
Since the access checks are performed for every view and for every link
|
||||
in the view the performace gain should be substantial.
|
||||
in the view the performance gain should be substantial.
|
||||
|
||||
Backwards Compatibility
|
||||
=======================
|
||||
|
||||
Reference in New Issue
Block a user