matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation. Add new translations chapter.

Browse Source
This commit is contained in:
Roberto Rosario
2015-08-24 00:33:46 -04:00
parent 59696ba68d
commit d0f0bdb34f
4 changed files with 36 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.rst
View File

@@ -29,6 +29,7 @@ account.
Release notes and upgrading <releases/index>
Concepts <topics/index>
Development <topics/development>
Translations <topics/translations>
Contributors <topics/contributors>
Licensing <topics/license>
FAQ <topics/faq>

9
docs/topics/development.rst
View File

@@ -460,15 +460,6 @@ You can also generate the documentation in formats other than HTML.
.. _Sphinx: http://sphinx.pocoo.org
Translations
------------
Translations are handled online via the **Transifex** website: https://www.transifex.com/projects/p/mayan-edms/.
To create a translation team for a new language or contribute to an already
existing language translation, create a **Transifex** account and contact
the team coordinator of the respective language in which you are interested.
Installable package
-------------------

44
docs/topics/permissions.rst
View File

@@ -9,7 +9,7 @@ perform. This control is divided into two levels of operation:
==============================
This level of activity control works by allowing roles that are composed
of users or groups, to be granted a permission such that the holder of that
of groups or users, to be granted a permission such that the holder of that
permission can exercise it throughout the entire collection of objects
(document, folders, tags, etc). This method could be thought out as a global
permission.
@@ -17,31 +17,25 @@ permission.
3 tier access control
=====================
When more control is desired over which objects actors
(user, groups and roles) can exercise an action, this method should be
used. Under this method, actors are granted a permission but only in relation
to a selected object. Example: Granting user
``Joe`` the ``Document view`` access control for document ``Payroll``, would
allow him to view this document only.
When more control is desired over which roles can exercise an action, this
method should be used. Under this method, roles are granted a permission but
only in relation to a selected object. Example: Granting role
``Accountants`` the ``Document view`` permission for document ``2015 Payroll report.txt``, would
allow only users in groups belonging to the ``Accountants`` role to view this document.
The permission system enforces inheritance by first checking, if the user
has a global permission, is a member of a group or a role that has a global
permission and if not, then checks to see if that user, a group or role to
which he belongs, has been granted access to the specific object to which
he is desiring to perform a given action.
Inherited access control
========================
Only when these checks fail the user is forbidden to perform the action and
a generic message is displayed to avoid providing any information
that could be used to sidetrack the permission system or obtain any kind of
information about the object to which the user was not allowed access.
It is also possible to grant a permission to a role for a specific document type.
Under this scheme all users in groups belonging to that role will inherit that
permission for all documents of that type.
Default Access Control Lists (Default ACLs)
-------------------------------------------
Example:
Default Access Control Lists allow assigment of an access control list to a
type of object (Document, Tags, Folders) before it is created. It is the default
permissions an object will have when it is created. With Default Access Control Lists
specific permissions can be granted to the creator of a document for example.
Changes to the Default Access Control Lists (Default ACLs) only affect objects
created after the change, they will not affect documents previously uploaded.
Role ``RH Supervisors`` are given the permission ``document view`` for the
document type ``Payroll reports``. Now all users in groups belonging to the
``RH Supervisors`` role can view all documents of the type ``Payroll reports``
without having to have that permissions granted for each particular Payroll report document.
If access control for the Payroll reports documents need to be updated it only needs
to be done for the document type class object and not for each document of the type
Payroll report.

16
docs/topics/translations.rst Normal file
View File

@@ -0,0 +1,16 @@
============
Translations
============
Translations are handled online via the **Transifex** website: https://www.transifex.com/projects/p/mayan-edms/.
To create a translation team for a new language or contribute to an already
existing language translation, create a **Transifex** account and contact
the team coordinator of the respective language in which you are interested.
Feel free to open translation issues inside **Transifex** itself if you have a question
about the usage or meaning of a source text string. If you open a translation issue,
it will be your resposibility to close it after you get an answers that satisfies
your question. Administrator will not close new issues as they have no way to determine
if your question has been properly answered. However to avoid cluter, answered
questions will be scanned periodically and closed if not activity is observed
from the original poster.