New style documentation

This commit is contained in:
Roberto Rosario
2015-05-20 21:25:17 -04:00
parent 7dd2963a4b
commit 5e4f28c83b
12 changed files with 155 additions and 116 deletions

View File

@@ -49,14 +49,14 @@ ACL support
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
to specific objects, there is a special user called `Creator`, use to
allow the access control list that the actual creator of an object will
inherit.
inherit.
Anonymous user support
~~~~~~~~~~~~~~~~~~~~~~
Anonymous user support is a two tier function, first is the addition of
@@ -78,32 +78,31 @@ Usability improvements
erases the previous one.
* Usability improvement in the role member's add/removal form, by using
HTML's option groups tag property
2 Step download process
~~~~~~~~~~~~~~~~~~~~~~~
The code for downloading single and multiple document and document versions
has been merged with compression support also added. This allows for the
download of documents in their original format or compressed and well as
the download of several documents in a single compressed file.
the download of several documents in a single compressed file.
Customizable GPG home directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Addition of the :setting:`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. For information about this new feature check the
:doc:`Initial data loading <../topics/initial_import>` chapter.
from a compressed file. For information about this new feature check the Initial data loading chapter.
Out of process user import
~~~~~~~~~~~~~~~~~~~~~~~~~~
A management command has been added to import a large number users
from a CSV file. More information about this new feature can also be found
in the :doc:`Initial data loading <../topics/initial_import>` chapter.
from a CSV file. More information about this new feature can also be found
in the Initial data loading chapter.
Refactored document indexing
@@ -123,7 +122,7 @@ mirrored on disk.
Help shape Mayan EDMS's future
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Included in this version is a small feedback application, found under the
Included in this version is a small feedback application, found under the
``About`` main menu, where users by just answering some questions can
help determine the priority of the next planned features on the pipeline,
or even help add new features if enough requests are received. All questions
@@ -169,7 +168,7 @@ When the following message appears
If you're unsure, answer 'no'.
Type 'yes' to continue, or 'no' to cancel:
Type ``yes`` and press **Enter**
And continue migrating database schema with::
@@ -213,7 +212,7 @@ Bugs fixed
==========
* Issue #17, special thanks to Dave Herring for all the help including
access to a machine suffering with the issue, and to Sergei Glita for
his research and eventual find of the core cause.
his research and eventual find of the core cause.
* Statistics fixes.
* Fixed get_image_cache_name regression in the OCR app.
@@ -221,12 +220,12 @@ Stuff removed
=============
* Support for Celery and Sentry has been drop
for now.
* Removed the 'db_index' argument from Text fields definition and
* Removed the 'db_index' argument from Text fields definition and
migrations as it was causing error messages for MySQL users, thanks to
Sergei Glita for reporting this one.
* Configuration options removed:
* OCR_CACHE_URI
* DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_PATH - Use the newest :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`
* DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE - Use the newest :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`

View File

@@ -11,7 +11,6 @@ Update to Django 1.6.11
~~~~~~~~~~~~~~~~~~~~~~~
The required version of Django has been updated to version 1.6.11_.
Minor changes
~~~~~~~~~~~~~
- Fix make_dist.sh script
@@ -23,9 +22,24 @@ Minor changes
- Removal of installation statistics gathering
- Remove unused folder tag
- Fix usage of ugettext to ugettext_lazy
- Increase size of the lock name field
- New style documentation
Upgrading from a previous version
=================================
Using PIP
~~~~~~~~~
Type in the console::
$ pip install mayan-edms==1.1.1
the requirements will also be updated.
Using Git
~~~~~~~~~
If you installed Mayan EDMS by cloning the Git repository issue the commands::
$ git reset --hard HEAD
@@ -37,6 +51,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
Add new static media::
$ mayan-edms.py collectstatic --noinput

View File

@@ -17,20 +17,13 @@ Final releases
Below are release notes through **Mayan EDMS** |version| and its minor releases. Newer
versions of the documentation contain the release notes for any later releases.
1.1 release
1.0 series
-----------
.. toctree::
:maxdepth: 1
1.1
1.1.1
1.0 release
-----------
.. toctree::
:maxdepth: 1
1.1
1.0
0.13 release