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

Documentation: Use Sphinx's extlinks to cut down on repeated URLs. Merge Administration and Maintenance topics. Add database conversion chapter. Unify the header format of all recent release notes. Fix :doc: references.

Browse Source 
Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2018-10-18 23:02:30 -04:00
parent 46d48cc5ea
commit b4f43adc1a
75 changed files with 2134 additions and 1455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
__init__.py.tmpl
View File

@@ -4,6 +4,7 @@ __title__ = 'Mayan EDMS'
__version__ = '{{ version }}'
__build__ = {{ build }}
__build_string__ = '{{ build_string }}'
__django_version__ = '1.11'
__author__ = 'Roberto Rosario'
__author_email__ = 'roberto.rosario@mayan-edms.com'
__description__ = 'Free Open Source Electronic Document Management System'

17
docs/chapters/acls.rst
View File

@@ -2,11 +2,11 @@
Access control lists
********************
Besides the permissions system explained in :doc:`permissions`, Mayan EDMS
provides per object permission granting. This feature is used to grant a
permission to a role, but this permission can only be executed for a limited
number of objects (documents, folders, tags) instead of being effective
system-wide.
Besides the permissions system explained in :doc:`../chapters/permissions`,
Mayan EDMS provides per object permission granting. This feature is used to
grant a permission to a role, but this permission can only be executed for a
limited number of objects (documents, folders, tags) instead of being
effective system-wide.
.. blockdiag::
@@ -40,9 +40,10 @@ would be able to view the ``2015 Payroll report.txt`` document.
Inherited access control
========================
It is also possible to grant a permission to a role for a specific document type (:doc:`document_types`).
Under this scheme all users in groups belonging to that role will inherit that
permission for all documents of that type.
It is also possible to grant a permission to a role for a specific document
type (:doc:`../chapters/document_types`). Under this scheme all users in
groups belonging to that role will inherit that permission for all documents
of that type.
.. blockdiag::

103
docs/chapters/database_conversion.rst Normal file
View File

@@ -0,0 +1,103 @@
*******************
Database conversion
*******************
Version 3.1.x added a new management command to help convert data residing in
an SQLite database to other database managers like PostgreSQL. Here is the
conversion procedure.
Direct install
==============
* Make a backup of your existing SQLite database and documents by copying the
``/opt/mayan-edms/media`` folder.
* :doc:`Upgrade to at least version 3.1.3. <../releases/3.1.3>`
* Migrate the existing SQLite database with the command ``performupgrade``::
sudo -u mayan MAYAN_MEDIA_ROOT=/opt/mayan-edms/media /opt/mayan-edms/bin/mayan-edms.py performupgrade
* Install PostgreSQL::
sudo apt-get install postgresql libpq-dev
* Provision a PostgreSQL database::
sudo -u postgres psql -c "CREATE USER mayan WITH password 'mayanuserpass';"
sudo -u postgres createdb -O mayan mayan
* Install the Python client for PostgreSQL::
sudo -u mayan /opt/mayan-edms/bin/pip install --no-cache-dir psycopg2==2.7.3.2
* Copy the newly created fallback config file::
cp /opt/mayan-edms/media/config_backup.yml /opt/mayan-edms/media/config.yml
* Edit the configuration file to add the entry for the PostgreSQL database and
rename the SQLite database to 'old'::
# Before
DATABASES:
default:
ATOMIC_REQUESTS: false
AUTOCOMMIT: true
CONN_MAX_AGE: 0
ENGINE: django.db.backends.sqlite3
HOST: ''
NAME: /opt/mayan-edms/media/db.sqlite3
OPTIONS: {}
PASSWORD: ''
PORT: ''
TEST: {CHARSET: null, COLLATION: null, MIRROR: null, NAME: null}
TIME_ZONE: null
USER: ''
# After
DATABASES:
old:
ATOMIC_REQUESTS: false
AUTOCOMMIT: true
CONN_MAX_AGE: 0
ENGINE: django.db.backends.sqlite3
HOST: ''
NAME: /opt/mayan-edms/media/db.sqlite3
OPTIONS: {}
PASSWORD: ''
PORT: ''
TEST: {CHARSET: null, COLLATION: null, MIRROR: null, NAME: null}
TIME_ZONE: null
USER: ''
default:
ATOMIC_REQUESTS: false
AUTOCOMMIT: true
CONN_MAX_AGE: 0
ENGINE: django.db.backends.postgresql
HOST: '127.0.0.1'
NAME: /opt/mayan-edms/media/db.sqlite3
OPTIONS: {}
PASSWORD: 'mayanuserpass'
PORT: ''
TEST: {CHARSET: null, COLLATION: null, MIRROR: null, NAME: null}
TIME_ZONE: null
USER: 'mayan'
* Migrate the new database to create the empty tables::
sudo -u mayan MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan MAYAN_DATABASE_PASSWORD=mayanuserpass MAYAN_DATABASE_USER=mayan MAYAN_DATABASE_HOST=127.0.0.1 MAYAN_MEDIA_ROOT=/opt/mayan-edms/media /opt/mayan-edms/bin/mayan-edms.py migrate
* Convert the data in the SQLite and store it in the PostgreSQL database::
sudo -u mayan MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan MAYAN_DATABASE_PASSWORD=mayanuserpass MAYAN_DATABASE_USER=mayan MAYAN_DATABASE_HOST=127.0.0.1 MAYAN_MEDIA_ROOT=/opt/mayan-edms/media /opt/mayan-edms/bin/mayan-edms.py convertdb --from=old --to=default --force
* Update the supervisor config file to have Mayan EDMS run from the PostgreSQL database::
[supervisord]
environment=
<...>
MAYAN_DATABASE_ENGINE=django.db.backends.postgresql,
MAYAN_DATABASE_HOST=127.0.0.1,
MAYAN_DATABASE_NAME=mayan,
MAYAN_DATABASE_PASSWORD=mayanuserpass,
MAYAN_DATABASE_USER=mayan,
MAYAN_DATABASE_CONN_MAX_AGE=360,
<...>

5
docs/chapters/deploying.rst
View File

@@ -1,5 +1,3 @@
.. _deploying:
******************
Direct deployments
******************
@@ -172,6 +170,9 @@ Enable and restart the services [1_]:
systemctl enable supervisor
systemctl restart supervisor
.. _deployment_advanced:
Advanced deployment
===================

9
docs/chapters/development.rst
View File

@@ -1,5 +1,3 @@
.. _development:
***********
Development
***********
@@ -270,7 +268,9 @@ Follow the latest contributing guidelines outlined here: https://gitlab.com/maya
Debugging
=========
Mayan EDMS makes extensive use of Django's new `logging capabilities`_.
Mayan EDMS makes extensive use of Django's new
:django-docs:`logging capabilities <topics/logging>`.
By default debug logging for all apps is turned on. If you wish to customize
how logging is managed turn off automatic logging by setting
`COMMON_AUTO_LOGGING` to ``False`` and add the following lines to your
@@ -322,9 +322,6 @@ Likewise, to see the debug output of the ``tags`` app, just add the following in
},
.. _`logging capabilities`: https://docs.djangoproject.com/en/dev/topics/logging
Documentation
=============

42
docs/chapters/docker.rst
View File

@@ -1,6 +1,3 @@
.. _docker:
============
Docker image
============
@@ -8,8 +5,10 @@ Docker image
How to use this image
=====================
Start a Mayan EDMS instance
------------------------------
.. _docker_install:
Start a Mayan EDMS image
------------------------
With Docker properly installed, proceed to download the Mayan EDMS image using the command::
@@ -113,7 +112,7 @@ instead of the IP address of the Docker host (``172.17.0.1``)::
mayanedms/mayanedms:<version>
Stopping and starting the container
--------------------------------------
-----------------------------------
To stop the container use::
@@ -125,6 +124,8 @@ To start the container again::
docker start mayan-edms
.. _docker_environment_variables:
Environment Variables
---------------------
@@ -148,43 +149,38 @@ or testing, never use it in production.
Defaults to 'mayan'. This optional environment variable can be used to define
the database name that Mayan EDMS will connect to. For more information read
the pertinent Django documentation page: `Connecting to the database`_
.. _Connecting to the database: https://docs.djangoproject.com/en/1.10/ref/databases/#connecting-to-the-database
the pertinent Django documentation page:
:django-docs:`Connecting to the database <ref/databases/#connecting-to-the-database>`
``MAYAN_DATABASE_USER``
Defaults to 'mayan'. This optional environment variable is used to set the
username that will be used to connect to the database. For more information
read the pertinent Django documentation page: `Settings, USER`_
.. _Settings, USER: https://docs.djangoproject.com/en/1.10/ref/settings/#user
read the pertinent Django documentation page:
:django-docs:`Settings, USER <ref/settings/#user>`
``MAYAN_DATABASE_PASSWORD``
Defaults to ''. This optional environment variable is used to set the
password that will be used to connect to the database. For more information
read the pertinent Django documentation page: `Settings, PASSWORD`_
.. _Settings, PASSWORD: https://docs.djangoproject.com/en/1.10/ref/settings/#password
read the pertinent Django documentation page:
:django-docs:`Settings, PASSWORD <ref/settings/#password>`
``MAYAN_DATABASE_HOST``
Defaults to `None`. This optional environment variable is used to set the
hostname that will be used to connect to the database. This can be the
hostname of another container or an IP address. For more information read
the pertinent Django documentation page: `Settings, HOST`_
.. _Settings, HOST: https://docs.djangoproject.com/en/1.10/ref/settings/#host
the pertinent Django documentation page:
:django-docs:`Settings, HOST <ref/settings/#host>`
``MAYAN_DATABASE_PORT``
Defaults to `None`. This optional environment variable is used to set the
port number to use when connecting to the database. An empty string means
the default port. Not used with SQLite. For more information read the
pertinent Django documentation page: `Settings, PORT`_
.. _Settings, PORT: https://docs.djangoproject.com/en/1.11/ref/settings/#port
pertinent Django documentation page:
:django-docs:`Settings, PORT <ref/settings/#port>`
``MAYAN_BROKER_URL``
@@ -223,9 +219,7 @@ Optional. Allows loading an alternate settings file.
Amount in seconds to keep a database connection alive. Allow reuse of database
connections. For more information read the pertinent Django documentation
page: `Settings, CONN_MAX_AGE`_
.. _Settings, CONN_MAX_AGE: https://docs.djangoproject.com/en/1.10/ref/settings/#conn-max-age
page: :django-docs:`Settings, CONN_MAX_AGE <ref/settings/#conn-max-age>`
``MAYAN_GUNICORN_WORKERS``

4
docs/chapters/document_types.rst
View File

@@ -1,9 +1,7 @@
.. _document_types:
Document types
==============
The basic unit of data in Mayan EDMS is the ``document type``. A document
The basic unit of data in Mayan EDMS is the **document type**. A document
type can be interpreted also as a document category, a document class, or a
document template. Every other aspect of the system will rely or be tied to
one or more document type. Create one document type for each type or class of

8
docs/chapters/indexes.rst
View File

@@ -1,12 +1,10 @@
.. _indexes:
Indexes
=======
Indexes are an automatic method to hierarchically organize documents in
relation to their properties (:doc:`metadata`, label, MIME type, etc). To use
indexes you need to first create an index template. Once created, associate
the index to one or more :doc:`document_types`.
relation to their properties (:doc:`../chapters/metadata`, label, MIME type,
etc). To use indexes you need to first create an index template. Once created,
associate the index to one or more :doc:`../chapters/document_types`.
Index are hierarchical models so a tree template needs to be specified for them.
This tree template will contain references to document metadata or properties

2
docs/chapters/mailing.rst
View File

@@ -1,5 +1,3 @@
.. _mailing:
*****************
Mailing documents
*****************

2
docs/chapters/metadata.rst
View File

@@ -1,5 +1,3 @@
.. _metadata:
********
Metadata
********

2
docs/chapters/object_storage.rst
View File

@@ -1,5 +1,3 @@
.. _object_storage:
**************
Object storage
**************

5
docs/chapters/password_reset.rst
View File

@@ -5,7 +5,7 @@ Password reset
To use the password reset feature, administrative emails need to be configured.
These are sent by the system itself and not by the users. Their usage and
configuration is different than the
:ref:`email system used to share documents via email<mailing>`.
:doc:`email system used to share documents via email<../chapters/mailing>`.
Sending administrative emails
=============================
@@ -24,9 +24,6 @@ Example::
EMAIL_USE_SSL: true
EMAIL_USE_TLS: false
For more details consult Django's documentation on the topic:
https://docs.djangoproject.com/en/1.11/ref/settings/#email-backend
To change the reference URL in the password reset emails on in the
default document mailing template modify the ``COMMON_PROJECT_URL`` setting.
For information on the different ways to change a setting check the

16
docs/chapters/scaling_up.rst
View File

@@ -1,6 +1,3 @@
.. _scaling_up:
**********
Scaling up
**********
@@ -22,9 +19,9 @@ The Gunicorn workers process HTTP requests and affect the speed at which the
website responds.
If you are using the Docker image, change the value of the
MAYAN_GUNICORN_WORKERS (https://docs.mayan-edms.com/topics/docker.html#environment-variables)
environment variable. Normally this variable defaults to 2. Increase this
number to match the number of CPU cores + 1.
``MAYAN_GUNICORN_WORKERS`` environment variable (check the Docker image chapter:
:ref:`docker_environment_variables`). Normally this variable defaults to 2.
Increase this number to match the number of CPU cores + 1.
If you are using the direct deployment methods, change the line that reads::
@@ -111,9 +108,8 @@ Redis as a message broker. To increase capacity and reduce volatility of
messages (pending tasks are not lost during shutdown) use RabbitMQ to
shuffle messages.
For direct installs refer to the Advanced deployment method
(https://docs.mayan-edms.com/topics/deploying.html#advanced-deployment) for
the required changes.
For direct installs refer to the :ref:`deployment_advanced` documentation
section for the required changes.
For the Docker image, launch a separate RabbitMQ container
(https://hub.docker.com/_/rabbitmq/)::
@@ -151,7 +147,7 @@ SSD drive for the ``/media`` sub folder. The location of the ``/media`` folder
will be specified by the ``MEDIA_ROOT`` setting.
If capacity is your bottom line, switch to an
:ref:`object storage <object_storage>` system.
:doc:`object storage <../chapters/object_storage>` system.
Use additional hosts
====================

14
docs/chapters/settings.rst
View File

@@ -2,9 +2,9 @@
Settings
********
Mayan EDMS can be configure via environment variables or by setting files.
.. _environment_variables:
Via environment variables
@@ -23,6 +23,7 @@ Restart Mayan EDMS and the new value will take effect. The "Settings" menu
can be used to verify if the overridden setting value is being interpreted
correctly.
.. _configuration_file:
Via YAML configuration file
@@ -53,20 +54,21 @@ This file is used to revert to the last know configuration file known
to be valid. You can revert manually by copy the file or by using the
``revertsettings`` management command from the command line.
Via Python settings files
=========================
Another way to configure Mayan EDMS is via Python-style, settings files.
If Mayan EDMS was installed using the Python package a ``mayan_settings``
folder will created for this purpose. If you installed Mayan EDMS
according to the :ref:`deploying` instructions provided in this
according to the :doc:`../chapters/deploying` instructions provided in this
documentation your ``mayan_settings`` folder should be located in the directory:
``/usr/share/mayan-edms/mayan/media/mayan_settings``.
If Mayan EDMS was installed using Docker, the ``mayan_settings`` folder
will be found inside the install Docker volume. If you installed Mayan EDMS
according to the :ref:`docker` instructions provided in this documentation
your ``mayan_settings`` folder should be located in the directory:
according to the :doc:`../chapters/docker` instructions provided in this
documentation your ``mayan_settings`` folder should be located in the directory:
``/docker-volumes/mayan/mayan_settings``.
Create a file with any valid name and a ``.py`` extension in the
@@ -94,7 +96,7 @@ For this example let's assume the file was saved with the name ``mysettings.py``
The way used to tell Mayan EDMS to import this file will vary based on the
installation method.
For the :ref:`deploying` method, the full import path will be
For the :doc:`../chapters/deploying` method, the full import path will be
``mayan.media.mayan_settings.mysettings`` and can be passed via the
``--settings`` command line argument like this::
@@ -104,7 +106,7 @@ or via the ``DJANGO_SETTINGS_MODULE`` environment variable like this::
export DJANGO_SETTINGS_MODULE=mayan.media.mayan_settings.mysettings
For the :ref:`docker` installation method, the full import path will be
For the :doc:`../chapters/docker` installation method, the full import path will be
``mayan_settings.mysettings`` and can only be passed via the
``MAYAN_SETTINGS_MODULE`` environment variable like this::

2
docs/chapters/smart_links.rst
View File

@@ -6,7 +6,7 @@ in their respective indexes. Smart links are useful when two documents are
related somehow but are of different type or different hierarchical units.
Example: A patient record can be related to a prescription drug information
document, but they each belong to their own :doc:`indexes`.
document, but they each belong to their own :doc:`../chapters/indexes`.
Smart links are rule based, but don't create any organizational structure.
Smart links just show the documents that match the rules as evaluated against

2
docs/chapters/sources.rst
View File

@@ -1,5 +1,3 @@
.. _sources:
Sources
=======

4
docs/chapters/versioning.rst
View File

@@ -26,8 +26,8 @@ revert to a previous version of the document is provided.
document_1 -> document_2;
}
Only the interactive document sources (:doc:`sources`) (``Web`` and ``Staging folders``) are
available to upload new document versions.
Only the interactive document sources (:doc:`../chapters/sources`)
(``Web`` and ``Staging folders``) are available to upload new document versions.
There is no limit to the number of versions a document can have.

49
docs/conf.py
View File

@@ -33,7 +33,9 @@ sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
#extensions = ["djangodocs", "sphinx.ext.intersphinx"]
extensions = ['sphinxcontrib.blockdiag', 'sphinxcontrib.spelling']
extensions = [
'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag', 'sphinxcontrib.spelling'
]
blockdiag_antialias = True
blockdiag_html_image_format = "SVG"
@@ -233,34 +235,17 @@ man_pages = [
html_theme = 'sphinx_rtd_theme'
from docutils import nodes, utils
from docutils.parsers.rst import roles
from sphinx.roles import _amp_re
def patched_menusel_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
text = utils.unescape(text)
if typ == 'menuselection':
text = text.replace('-->', 'qwe\N{RIGHTWARDS ARROW}') # Here is the patch
spans = _amp_re.split(text)
node = nodes.emphasis(rawtext=rawtext)
for i, span in enumerate(spans):
span = span.replace('&&', '&')
if i == 0:
if len(span) > 0:
textnode = nodes.Text(span)
node += textnode
continue
accel_node = nodes.inline()
letter_node = nodes.Text(span[0])
accel_node += letter_node
accel_node['classes'].append('accelerator')
node += accel_node
textnode = nodes.Text(span[1:])
node += textnode
node['classes'].append(typ)
return [node], []
# Use 'patched_menusel_role' function for processing the 'menuselection' role
roles.register_local_role('menuselection', patched_menusel_role)
# -- External links --
extlinks = {
'django-docs': (
'https://docs.djangoproject.com/en/{}/%s'.format(
mayan.__django_version__
), 'Django documentation section: '
),
'github-issue': (
'https://github.com/mayan-edms/mayan-edms/issues/%s', 'GitHub issue #'
),
'gitlab-issue': (
'https://gitlab.com/mayan-edms/mayan-edms/issues/%s', 'GitLab issue #'
)
}

3
docs/index.rst
View File

@@ -27,9 +27,8 @@ repository for electronic documents.
topics/settings
topics/storage
topics/integration
topics/maintenance
topics/administration
topics/advanced
topics/administration
topics/development
topics/faq
topics/license

66
docs/releases/0.12.1.rst
View File

@@ -1,13 +1,12 @@
================================
Mayan EDMS v0.12.1 release notes
================================
Version 0.12.1
==============
*May 2012*
This is the first maintenance release of the 0.12 series.
Overview
========
--------
While bug fixes and minor feature were the focus for this release, some
bigger changes were included because of their importance. The parsing of
@@ -19,11 +18,12 @@ environments where users don't have the ability to install OS level
binaries.
What's new in Mayan EDMS v0.12.1
================================
Changes
-------
Fabric file (fabfile)
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
A Fabric file is included to help users not very familiar with Ubuntu,
Python and Django install Mayan EDMS, or for system administrators
looking to automate the install whether in local or remote systems.
@@ -33,54 +33,66 @@ Feel free to submit your configuration settings and files for different database
webserver or Linux distribution. More configurations will be added to
the fabfile as more are tested.
Documentation update
~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^
The installation instructions were updated to include the installation of
the libpng-dev and libjpeg-dev libraries as well as the installation of
the poppler-utils package. An additional step to help users test their
the ``poppler-utils`` package. An additional step to help users test their
new installation of Mayan EDMS was also added.
Translations
~~~~~~~~~~~~
^^^^^^^^^^^^
The Italian translation has been synchronized with the source files at
Transifex and finished to %100 completion.
Usability improvements
~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^
The index instance view now feature the same multi document action
buttons (Submit to OCR, delete, download, etc) as the mail and recent
document views.
Better office document conversion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A new method of converting office documents has been implemented, this
new method doesn't require the use of the command line utility ``UNOCONV``.
If this new method proves to work better than previous solutions the use
of ``UNOCONV`` may be deprecated in the future. The conversion method
adds just one new configuration option: `CONVERTER_LIBREOFFICE_PATH`
which defaults to '/usr/bin/libreoffice'.
adds just one new configuration option: ``CONVERTER_LIBREOFFICE_PATH``
which defaults to ``/usr/bin/libreoffice``.
Better PDF text parsing
~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^
Brian E. submitted a patch to use the Poppler package pdftotext utility to
extract text from PDF files. This is now the default method Mayan EDMS
will execute to try to extract text from a PDF and failing that will
fallback to the previous method. This change add a new configuration
option: `OCR_PDFTOTEXT_PATH` to specify the location of the ``pdftotext``
executable, it defaults to '/usr/bin/pdftotext'. Be sure to install the
option: ``OCR_PDFTOTEXT_PATH`` to specify the location of the ``pdftotext``
executable, it defaults to ``/usr/bin/pdftotext``. Be sure to install the
``poppler-utils`` os package to take advantage of this new parser.
Changed defaults
~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^
The OCR queue is now active by default when first created during the
``syncdb`` phase and the `OCR_AUTOMATIC_OCR` option now defaults
``syncdb`` phase and the ``OCR_AUTOMATIC_OCR`` option now defaults
to ``True``. These two changes are made to reduce the steps required for
new users to start enjoying the benefits of automatic text extraction from
uploaded documents without having to read the documentation and have a more
functional default install.
Upgrading from a previous version
=================================
---------------------------------
Start off by adding the new requirements::
@@ -104,13 +116,17 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed
==========
* Issue #25 "Office document conversion error"
----------
:github-issue:`25` "Office document conversion error"
Removals
--------
Stuff removed
=============
* None

63
docs/releases/0.12.2.rst
View File

@@ -1,14 +1,12 @@
================================
Mayan EDMS v0.12.2 release notes
================================
Version 0.12.2
==============
*June 2012*
This is the second maintenance release of the 0.12 series.
Overview
========
--------
As with the previous release bug fixes and minor feature were the focus
for this release too. `issue #24`_ has been fixed and document
@@ -19,24 +17,28 @@ the diagnosis of installation of runtime error a simple view showing the
number of internal interval jobs being used by Mayan EDMS as well as a
new app which shows a detail of the current installation enviroment were added.
What's new in Mayan EDMS v0.12.2
================================
Changes
-------
Smarter auto admin creation
~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mayan EDMS creates a administrator user during the
database creation phase to reduce the amount of steps required for a
functional install. The creation of this account is controlled by the configuration
option `COMMON_AUTO_CREATE_ADMIN`, the username of the account is
specified with the configuration option `COMMON_AUTO_ADMIN_USERNAME`
and the password of this account by the option `COMMON_AUTO_ADMIN_PASSWORD`.
Previously the `COMMON_AUTO_ADMIN_PASSWORD` defaulted to 'admin' which
option ``COMMON_AUTO_CREATE_ADMIN``, the username of the account is
specified with the configuration option ``COMMON_AUTO_ADMIN_USERNAME``
and the password of this account by the option ``COMMON_AUTO_ADMIN_PASSWORD``.
Previously the ``COMMON_AUTO_ADMIN_PASSWORD`` defaulted to 'admin' which
created an administrator account of username 'admin' with a password of
'admin'. The new default is to randomize an initial password and show this password
at the login screen until the administrator password is changed.
Document check outs
~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^
As per the feature request filed under `issue #26`_, a new document
check out and check in functionality has been added. Users can now
check out a document and lock new version of it from being uploaded to avoid
@@ -47,8 +49,10 @@ new versions of it or check the document back in before the expiration period,
unless being granted the ``Allow overriding check out restrictions`` or
``Forcefully check in documents`` permission respectively.
Installation environment app
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Diagnosting remote installations of web based applications without access to the
command line can be a bit hard, to alleviate this situation a new installation
environment details app has been added. The purpose of this app is to provide
@@ -56,19 +60,25 @@ support staff information about the physical environment where Mayan EDMS has
been installed. To avoid possible security compromises only administrators
can access this app.
Editable compressed documents filename
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Previously when downloading more than one document in a compressed manner,
Mayan EDMS would produce a file with the name ``document_bundle.zip`` for
download. A different filename can now be specified at the same download dialog.
German translation
~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^
A German language translation has been added thanks to Tetja Rediske
and Tilmann Sittig.
Statistics gathering
~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^
Previous attempts at gathering usage statistics have been met with deficient results.
User participation in surveys as well as the quality of the data entered by users
was disappointing. That is why this version of Mayan EDMS features an
@@ -76,7 +86,7 @@ anonymous statistics gathering functionality.
Upgrading from a previous version
=================================
---------------------------------
Start off by adding the new requirements::
@@ -97,19 +107,22 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed
==========
* `issue #24`_ "Duplicated filename extension when uploading a new version of a document"
* `issue #26`_ "checkout feature request"
----------
:github-issue:`24 "Duplicated filename extension when uploading a new version of a document"
:github-issue:`26` "checkout feature request"
Removals
--------
Stuff removed
=============
* Feedback app
.. _issue #24: https://github.com/rosarior/mayan/issues/24
.. _issue #26: https://github.com/rosarior/mayan/issues/26

109
docs/releases/0.12.rst
View File

@@ -1,15 +1,12 @@
==============================
Mayan EDMS v0.12 release notes
==============================
Version 0.12
============
*February 2012*
Welcome to Mayan EDMS v0.12!
This release commemorates Mayan EDMS first aniversary!
Overview
========
--------
Aside from new features, the focus of this release of Mayan EDMS also
been about improving the code and documentation quality standard
@@ -38,11 +35,12 @@ releases:
* Removal of remarked code.
What's new in Mayan EDMS v0.12
==============================
Changes
-------
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.
@@ -57,56 +55,71 @@ ACL support
allow the access control list that the actual creator of an object will
inherit.
Anonymous user support
~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^
Anonymous user support is a two tier function, first is the addition of
the `COMMON_ALLOW_ANONYMOUS_ACCESS` configuration option that
allows non authenticated user to browse all the pages of a Mayan EDMS installation.
The second part of this support is the ability to assign permissions
or individual access to objects to anonymous users.
the ``COMMON_ALLOW_ANONYMOUS_ACCESS`` configuration option that
allows non authenticated user to browse all the pages of a Mayan EDMS
installation. The second part of this support is the ability to assign
permissions or individual access to objects to anonymous users.
Translations
~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^
A new Italian translation is available, provided by SeeOpen.IT
(www.seeopen.it, info@seeopen.it) as well as complete Russian translation
update by Sergei Glita. Included in this release also the initial translation
to Polish by mic.
Usability improvements
~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^
* Detached signature behavior improved, uploading a new detached signature
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.
Customizable GPG home directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Addition of the `SIGNATURES_GPG_HOME` configuration option to let
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Addition of the ``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 Initial data loading 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 Initial data loading chapter.
Refactored document indexing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:doc:`The document indexing <../chapters/indexes>` functionality has been
improved and moved from experimental
stage to beta stage. Index configuration menus are now available on the
@@ -116,12 +129,14 @@ 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
has been added, `DOCUMENT_INDEXING_FILESYSTEM_SERVING`, which maps
has been added, ``DOCUMENT_INDEXING_FILESYSTEM_SERVING``, which maps
the index internal name with the physical directory where such index will be
mirrored on disk.
Help shape Mayan EDMS's future
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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,
@@ -129,8 +144,10 @@ or even help add new features if enough requests are received. All questions
are optional but answering as many as possible will help greatly understand
the need of the Mayan EDMS user base.
Staging file previews
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
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
@@ -138,8 +155,23 @@ page of staging files without having to click and close each one
individually.
Removals
--------
* Support for Celery and Sentry has been drop
for now.
* 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 `DOCUMENT_INDEXING_FILESYSTEM_SERVING`
* DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE - Use the newest `DOCUMENT_INDEXING_FILESYSTEM_SERVING`
Upgrading from a previous version
=================================
---------------------------------
Start off by adding the new requirements::
@@ -201,31 +233,20 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
The permission system has been completely reworked so sadly this is a
place where even data migration can't help and the permissions assigned
to roles will be lost during the upgrade to version 0.12. Users, groups
and roles will be preserved only permissions need to be assigned again,
so write down your role permission setup before upgrading.
Bugs fixed
==========
* Issue #17, special thanks to Dave Herring for all the help including
----------
* :github-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.
* Statistics fixes.
* Fixed get_image_cache_name regression in the OCR app.
Stuff removed
=============
* Support for Celery and Sentry has been drop
for now.
* 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 `DOCUMENT_INDEXING_FILESYSTEM_SERVING`
* DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE - Use the newest `DOCUMENT_INDEXING_FILESYSTEM_SERVING`

129
docs/releases/0.13.rst
View File

@@ -1,51 +1,58 @@
================================
Mayan EDMS v0.13 release notes
================================
Version 0.13
============
*December 2012*
Welcome to Mayan EDMS v0.13!
Overview
========
--------
Initially this version was meant as a the third maintenance release of
the 0.12 series, but with the amount of changes and updates that were included
it was obvious this was not just a bug fix version anymore hence the version
jump to 0.13 instead of 0.12.3
What's new in Mayan EDMS v0.13
================================
Changes
-------
Django 1.3.5
~~~~~~~~~~~~
^^^^^^^^^^^^
This release updates the required version of Django to 1.3.5 to take advantage
of the security fixes added to that version of the framework.
Bulk document tagging and untagging
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As requested by issue `issue #31`_ this feature has been implemented and enabled in this version.
Attaching or removing tags from a large number of documents is now much easier.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
As requested by issue `issue #31`_ this feature has been implemented and
enabled in this version. Attaching or removing tags from a large number of
documents is now much easier.
Registration
~~~~~~~~~~~~
Based on requests made by the community for greater commercial support and services for
Mayan EDMS, a new feature has been added that allows users to register their
copies of Mayan EDMS and better help users with commercial support packages.
Registration for non commercial users is voluntary and optional, and in no way
affects the functionality of Mayan EDMS. However even for non commercial users
registration offers the advantage of automatically branding the user's copy
of Mayan EDMS with their name or the company name in the title area.
^^^^^^^^^^^^
Based on requests made by the community for greater commercial support and
services for Mayan EDMS, a new feature has been added that allows users
register their copies of Mayan EDMS and better help users with commercial
support packages. Registration for non commercial users is voluntary and
optional, and in no way affects the functionality of Mayan EDMS. However
even for non commercial users registration offers the advantage of
automatically branding the user's copy of Mayan EDMS with their name or the
company name in the title area.
Per document type indexing
~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^
Index can now be restricted to update only on specific document types, this
greatly increases the usefulness of indexes, and prevents unwanted index
updates.
Bootstrap
~~~~~~~~~
^^^^^^^^^
Setting up Mayan EDMS after installation has been indetified by users as the
main difficulty when knowledge about Mayan EDMS is relatively low. To
address this situation a new feature that provides preconfigured setups has been
@@ -60,51 +67,66 @@ their clients with customized setups without having to access their clients'
Mayan EDMS instances. ``JSON``, ``YAML`` and a custom ``YAML`` format
(http://djangosnippets.org/snippets/2461/) are supported by this new app.
Add documents to folders in bulk
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
As requested, the ability to add more than one document at a time to a selected
folder has been added.
Translation updates
~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^
The translation for all the current languages were synchronized to the
latest transifex project sources.
Model updates
~~~~~~~~~~~~~
^^^^^^^^^^^^^
Several small fixes to the behavior of some model were added, namely that
the names of some models should be unique. The document type name as well
as the metadata set name were two models that were updated to behave this way.
Navigation updates
~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^
There were some additions and changes to the navigation to make it more intuitive
or to add an alternate way to access the same information better. The bulk
attachment of tags was one of these. Previously users were added or removed from groups,
now users can be assigned to groups without leaving the user view. The name of an
existing metadata set can now be edited and what was previously called metadata set edit
is now more aptly named metadata members which adds or removes metadata types into a
single organizational unit. An error that caused a duplicate menu link in the
document type filename view was also fixed.
attachment of tags was one of these. Previously users were added or removed
from groups, now users can be assigned to groups without leaving the user view.
The name of an existing metadata set can now be edited and what was previously
called metadata set edit is now more aptly named metadata members which adds
or removes metadata types into a single organizational unit. An error that
caused a duplicate menu link in the document type filename view was also fixed.
Support for UNOCONV dropped
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Support for converting office documents by calling LibreOffice via UNOCONV
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Support for converting office documents by calling LibreOffice via ``UNOCONV``
has been disabled for a while ever since LibreOffice start including
document conversion support from the command line. This version completly
removes any traces of code and configuration options related to UNOCONV.
removes any traces of code and configuration options related to ``UNOCONV``.
Optimizations
~~~~~~~~~~~~~
Inspired by the idea of getting Mayan EDMS running effectively on low power hardware such as
the Raspberry Pi, several rounds or profiling and optimization were done.
^^^^^^^^^^^^^
Inspired by the idea of getting Mayan EDMS running effectively on low power
hardware such as the Raspberry Pi, several rounds or profiling and
optimization were done.
Some caching optimization were introduced to the permission model, resulting in
a speed increase of 33% in rendering time on views with heavy permission checking
and a 18% query reduction on cache hits.
Upgrading from a previous version
=================================
---------------------------------
If you installed Mayan EDMS by cloning the Git repository issue the commands::
$ git reset --hard HEAD
@@ -133,21 +155,24 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `issue #28`_ "Document indexing based on filesystem problem"
* `issue #29`_ Default ACL documentation
* `issue #30`_ "Ubuntu 12.0.4 LTS complaining about mising 'fabfile/templates/settings_local.py' (master branch)"
* `issue #31`_ "Bulk add tags Feature request"
* `issue #32`_ "Error run $python manage.py syncdb"
* `issue #33`_ "Fetches translations from Transifex. "
* `issue #34`_ "Initial syncdb fails because of import time database access"
* `issue #35`_ "Fix first install syncdb on Postgres"
* `issue #37`_ "When 19 >= &document_type_id >= 10 in url, error page not found"
* `issue #39`_ Feature request "Bulk move folders"
---------------------------
* :github-issue:`28` "Document indexing based on filesystem problem"
* :github-issue:`29` Default ACL documentation
* :github-issue:`30` "Ubuntu 12.0.4 LTS complaining about mising 'fabfile/templates/settings_local.py' (master branch)"
* :github-issue:`31` "Bulk add tags Feature request"
* :github-issue:`32` "Error run $python manage.py syncdb"
* :github-issue:`33` "Fetches translations from Transifex. "
* :github-issue:`34` "Initial syncdb fails because of import time database access"
* :github-issue:`35` "Fix first install syncdb on Postgres"
* :github-issue:`37` "When 19 >= &document_type_id >= 10 in url, error page not found"
* :github-issue:`39` * `issue #39`_ Feature request "Bulk move folders"
.. _issue #28: https://github.com/rosarior/mayan/issues/28

105
docs/releases/1.0.rst
View File

@@ -1,13 +1,10 @@
=============================
Mayan EDMS v1.0 release notes
=============================
Version 1.0
===========
*August 26, 2014*
Welcome to Mayan EDMS v1.0!
Overview
========
--------
After a year of low activity the focus of this release was to get the code
updated to work with the most recent version of Django and the most recent
version of the dependencies Mayan EDMS uses. The goal was to have a strong
@@ -16,25 +13,30 @@ fixes were the primary focus of this cycle. Because of this not much
emphasis was placed on adding new features, or at least new features
that could have the potential to break things.
What's new in Mayan EDMS v1.0
=============================
Changes
-------
New home
~~~~~~~~
^^^^^^^^
The growth and reach of the project has necessitaded for a while the move
of the project to its own organization in Github. This move has finally been
done, the new URL of the project is: https://github.com/mayan-edms/mayan-edms
Django 1.6
~~~~~~~~~~
^^^^^^^^^^
This release updates the required version of Django to 1.6, bringing with it
not only new features, but also a lot of security updates, a new project
directory structure and new deployment methods.
Translation updates
~~~~~~~~~~~~~~~~~~~
The translation for all languages were synchronized to the latest transifex project sources.
Translation completion as reported by Transifex:
^^^^^^^^^^^^^^^^^^^
The translation for all languages were synchronized to the latest transifex
project sources. Translation completion as reported by Transifex:
* English - 100%
* Spanish - 100%
@@ -59,96 +61,127 @@ Translation completion as reported by Transifex:
* Croatian - 3%
* Turkish - 3%
Model updates
~~~~~~~~~~~~~
^^^^^^^^^^^^^
There were some convenience properties created to allow quick access to
a document's version and pages. These custom properties were removed and
an official method to access these properties as provided by Django is now
used.
Source code improvements
~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^
A circular import of metadata and document_index apps code from the documents app
was removed. Document index updates are now handled via signals, not called
directly as before. Hundreds of PEP8 style fixes, unused import removals,
unused variables removals and removal of remarked or unused code. Removal of the
DEVELOPMENT flag (was used to trigger static media serving during development),
this is now handled by the DEBUG flag. The DEBUG flag is now set to `True` by
``DEVELOPMENT`` flag (was used to trigger static media serving during development),
this is now handled by the ``DEBUG`` flag. The ``DEBUG`` flag is now set to ``True`` by
default as per Django 1.6 defaults. Removed usage of Django's JSON libraries
using Python's JSON library instead. Update of time and date use to use Django's
new timezone aware data and time handling. Removal of custom code in favor of using
modules provided by Django or by existing 3rd party libraries. Unification of code
used for equal or similar purpose in various modules.
Removal of included 3rd party modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
One last 3rd party module was included with the source code of Mayan EDMS.
This module is now available on PyPI and fetched during the installation instead
of being included.
Automatic testing and code coverage check
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Some initial tests were added, which will help with the detection of
regressions or bugs when adding new features. More tests are needed, but
the initial work has being started.
Update of required modules and libraries versions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Many of the required modules and libraries have been updated to a more
recent version if not to their most recent released version.
Database connection leaks
~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^
Stale database connection being left open by scheduler tasks are now explictly
closed. This avoids consumption of the pool of database connections, increases
stability and reduces memory usage.
Deletion of detached signatures
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Detached signatures can now be deleted, if accidentally added to the wrong document.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Detached signatures can now be deleted, if accidentally added to the wrong
document.
Removal of fabric based installations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These files are now part of their own project and located at https://github.com/mayan-edms/mayan-fabric
Pluggable OCR backends
~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^
A commonly requested feature, it is now possible to write backends drivers
to do document OCR using software or services other than Tesseract.
OCR improvements
~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^
OCR queue state is now reset when reloading Mayan EMDS, avoiding the OCR queue
to remain locked. `unpaper` binary is now an optional pre OCR requirement, the OCR
queue will now continue working is `unpaper` is not installed. Addition of post
queue will now continue working is ``unpaper`` is not installed. Addition of post
OCR processing support for French and German.
License change
~~~~~~~~~~~~~~
^^^^^^^^^^^^^^
Mayan EDMS is now licensed under the Apache 2.0 license. This means many
things but the main change is that inclusion of Mayan EDMS into
commercial products is now explicitly allowed.
PyPI package
~~~~~~~~~~~~
^^^^^^^^^^^^
Mayan EDMS has been packaged and submitted to the PyPI_ Python Package Index
making it even easier to install and use.
New REST API
~~~~~~~~~~~~
^^^^^^^^^^^^
This release feature a completely new REST API and automatic API documentation.
This new API is also used internally by *Mayan EDMS* itself.
This new API is also used internally by Mayan EDMS itself.
Other changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
More office document types are now recognized and supported. More file types are now
supported as text files and properly previewed and parsed. Removal of the legacy
runserver.sh and runserver_plus.sh scripts. New document preview generation and
display pipeline, faster, simpler. Inclusion of a proof of concept compressed storage
backend.
Upgrading from a previous version
=================================
---------------------------------
If you installed Mayan EDMS by cloning the Git repository issue the commands::
$ git reset --hard HEAD
@@ -175,7 +208,8 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* If using the SQLite3 database option, rename the file named `mayan.sqlite` file to `db.sqlite3` and
move it to the new `media` provided folder.
* Also move to the `media` folder any `gpg_home`, `document_storage` and `image_cache` folders
@@ -183,7 +217,8 @@ Backward incompatible changes
Bugs fixed or issues closed
===========================
---------------------------
* None

37
docs/releases/1.1.1.rst
View File

@@ -1,18 +1,19 @@
===============================
Mayan EDMS v1.1.1 release notes
===============================
Version 1.1.1
=============
Released: May 21, 2015
What's new
==========
Changes
-------
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
- Add test for issue #163
- Activate tests for the sources app
@@ -25,11 +26,12 @@ Minor changes
- Increase size of the lock name field
- New style documentation
Upgrading from a previous version
=================================
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -37,8 +39,9 @@ Type in the console::
the requirements will also be updated.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -51,8 +54,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Add new static media::
@@ -62,11 +66,14 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
None
-----------------------------
* None
Bugs fixed or issues closed
===========================
None
---------------------------
* None
.. _1.6.11: https://docs.djangoproject.com/en/1.8/releases/1.6.11/

275
docs/releases/1.1.rst
View File

@@ -1,17 +1,14 @@
=============================
Mayan EDMS v1.1 release notes
=============================
Version 1.1
===========
Released: February 10, 2015
Welcome to Mayan EDMS v1.1
What's new in Mayan EDMS v1.1
=============================
Changes
-------
Celery
~~~~~~
^^^^^^
All background tasks processing has been converted to use Celery_. By default
Mayan EDMS runs in "Eager" until a broker and result backend are configured
as per `Celery's documentation`_. This change made the built-in scheduler and
@@ -19,72 +16,83 @@ job_processing apps obsolete, both were removed.
Views namespaces
~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^
All views are namespaced_ with the name of the app which defines them. If you have
developed 3rd party apps for Mayan EDMS be sure to update any reference to a view
by prepending the app name to the view name.
Removal of the splash screen
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The static image home screen has been replaced with a quick links view, showing
the most used actions: Uploading documents, viewing recent documents, viewing
all documents and searching documents.
Sending and receiving documents via email
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A link or entire documents can be sent as attachments via email. Documents can
also be received via email with the addition of two document sources named IMAP and POP3
which correspond to the mail protocol used to fetch the documents. Read Django's
`email configuration settings documentation`_ for more details on how to set up
mail serving.
also be received via email with the addition of two document sources named IMAP
and POP3 which correspond to the mail protocol used to fetch the documents.
Read Django's `email configuration settings documentation`_ for more details
on how to set up mail serving.
Update to Django 1.6.8
~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^
Mayan EDMS has been updated to use Django 1.6.8.
Events app
~~~~~~~~~~
^^^^^^^^^^
The built-in history app has been removed in favor of a new events wrapper app
for `Django activity stream`_
Watch folders
~~~~~~~~~~~~~
^^^^^^^^^^^^^
Filesystem folders can be monitored for change and their files automatically
uploaded as documents in Mayan EDMS.
Vagrant file included
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
A vagrant file is now included to allow developers to provision a virtual machine
with the latest development version of Mayan EDMS.
User locale profile (language and timezone)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Interface language and locale setting can now be setup for each user and are not
installation wide as before. Date and times offsets are automatically ajusted to
each user's timezone settings.
Document states
~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^
A new simple workflow app that can represent document states has been included.
Explicit document types needed per index
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Indexes can now be tied to document types, eliminating the need to update
indexes for every document update. Indexes will only update when a document of
the type to which they are associated is updated.
Optional and required metadata types
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Metadata types can now be assigned in two ways to documents types, as optional or
required. Values for required metadata types as the name implies, must be entered
for documents to be able to be uploaded. Optional metadata types on the other hand
@@ -92,14 +100,16 @@ can be left blank by the user.
Bulk document type change
~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^
It is now possible to change the document type of previously uploaded documents.
When the document type of a document is changed the metadata values are reset and
the metadata types of the new document type are automatically assigned.
New release cycle
~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^
Starting with this version a new release cycle methodology will come into effect.
The goal of this release cycle is to allow two series of versions of Mayan EDMS to be
active at a given time: A new major version with new functionality and a minor version
@@ -110,29 +120,36 @@ maintenance mode.
Deprecation of Python 2.6
~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^
Series 1.0 of Mayan EDMS will be the last series supporting Python 2.6. Series
2.0 will be using Django 1.7.x which itself requires Python 2.7 or later.
Improved testings
~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^
Mayan EDMS is now automatically tested against SQLite, MySQL and PostgreSQL.
API updates
~~~~~~~~~~~
Many new API endpoints have been added exposing the majority of Mayan EDMS functionality.
^^^^^^^^^^^
Many new API endpoints have been added exposing the majority of Mayan EDMS
functionality.
Messages contextual improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Many updates and simplifications were made to the source text messages to reduce the
difficulty of translating Mayan EDMS and maintaing the contextual meaning of the
text messages.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Many updates and simplifications were made to the source text messages to
reduce the difficulty of translating Mayan EDMS and maintaing the contextual
meaning of the text messages.
Improved method for custom settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Custom settings now use a string based value, it is longer needed to import
classes when customizing a setting::
@@ -145,64 +162,71 @@ Instead the fully qualified name of the class must be passed as the setting valu
Removal of the OCR config setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
OCR behavior is now a document type property meaning that it can be turned
on or off for specific document types.
Per document language setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Previously the document language used for OCR was specified for the entire
installation. If documents in multiple languages were uploaded some suffered
lower success rates. Now the language of each document can be specified.
Metadata validation and parsing support
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It is now possible to create functions to validate metadata value input or
parse and store corrected values. Three sample metadata validations functions
are included: ``Parse date and time``, ``Parse date`` and ``Parse time``.
Removal of 960 grid system in favor Pure CSS's grid system
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
By using Pure CSS's columns based grid system, the move towards a
Bootstrap UI migration has advanced greatly.
Simplified UI
~~~~~~~~~~~~~
^^^^^^^^^^^^^
All user actions as well as the logout button are now under the user functions
section.
Stable PDF previews generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The way PDF were being generated has been improved greatly eliminating
spurious segmentation faults at the expense of a small speed penalty.
More technical documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Many new sub topics were added to the development section of the documentation
to allow developers to better understand the inner workings and philosophies
of Mayan EDMS.
Other changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
* Removal of the MAIN_SIDE_BAR_SEARCH setting
* Removal of THEMES and themes support
* Removal of VERBOSE_LOGIN setting
* Removal of the ``MAIN_SIDE_BAR_SEARCH`` setting
* Removal of ``THEMES`` setting and themes support
* Removal of ``VERBOSE_LOGIN`` setting
* Removal of graphics backend supported file format list view
* Removal of the MAIN_DISABLE_ICONS setting
* Removal of the ``MAIN_DISABLE_ICONS`` setting
* Removal of specialized Sentry support
* Removal of the MAIN_ENABLE_SCROLL_JS setting
* Removal of the ``MAIN_ENABLE_SCROLL_JS`` setting
* Remove hardcoded root (/) redirections
* Removal of APSCheduler as a requirement
* Removal of ``APSCheduler`` as a requirement
* Removal of the scheduled jobs view
* Removal of the web_theme app
* Removal of the ``web_theme`` app
* Removal of the sources icon selection support
* Removal of the in-app help panels
* Removal of the duplicate document search feature
@@ -212,7 +236,8 @@ Other changes
Upgrading from a previous version
=================================
---------------------------------
IMPORTANT! Before running the upgrade make sure none of your documents have
duplicated metadata types, meaning that the same metadata type must not appear
twice for any given document.
@@ -278,7 +303,7 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* You will have to redefine your document sources due to the new extended models
for this app.
@@ -287,80 +312,80 @@ Backward incompatible changes
Bugs fixed or issues closed
===========================
---------------------------
* `issue #30 <https://github.com/mayan-edms/mayan-edms/issues/30>`_ Document workflows
* `issue #32 <https://github.com/mayan-edms/mayan-edms/issues/32>`_ Watched folders
* `issue #34 <https://github.com/mayan-edms/mayan-edms/issues/34>`_ Postprocessing document queue
* `issue #35 <https://github.com/mayan-edms/mayan-edms/issues/35>`_ Metadata validation
* `issue #37 <https://github.com/mayan-edms/mayan-edms/issues/37>`_ Add from __future__ import unicode_literals
* `issue #39 <https://github.com/mayan-edms/mayan-edms/issues/39>`_ Capitalization of messages
* `issue #40 <https://github.com/mayan-edms/mayan-edms/issues/40>`_ Update references to root ('/') path
* `issue #46 <https://github.com/mayan-edms/mayan-edms/issues/46>`_ Advanced search past 1st page
* `issue #49 <https://github.com/mayan-edms/mayan-edms/issues/49>`_ Problems with large pdf files
* `issue #50 <https://github.com/mayan-edms/mayan-edms/issues/50>`_ raise CommandNotFound(path)
* `issue #51 <https://github.com/mayan-edms/mayan-edms/issues/51>`_ Search with ANONYMOUS error
* `issue #55 <https://github.com/mayan-edms/mayan-edms/issues/55>`_ Document approval cicle?
* `issue #56 <https://github.com/mayan-edms/mayan-edms/issues/56>`_ Removal of non essential features, views, models
* `issue #57 <https://github.com/mayan-edms/mayan-edms/issues/57>`_ Migrate to Celery for task query and periodic tasks
* `issue #64 <https://github.com/mayan-edms/mayan-edms/issues/64>`_ Pluralize messages properly
* `issue #65 <https://github.com/mayan-edms/mayan-edms/issues/65>`_ Backport the ability to receive documents via email
* `issue #66 <https://github.com/mayan-edms/mayan-edms/issues/66>`_ Python 3 compatibility: Add from __future__ import unicode_literals and remove all u''
* `issue #68 <https://github.com/mayan-edms/mayan-edms/issues/68>`_ Revise and update the use gettext vs. gettext_lazy
* `issue #69 <https://github.com/mayan-edms/mayan-edms/issues/69>`_ Feature removal: remove "Unregistered" message from the title bar
* `issue #71 <https://github.com/mayan-edms/mayan-edms/issues/71>`_ Add retry support to the converter task
* `issue #72 <https://github.com/mayan-edms/mayan-edms/issues/72>`_ Delete unused static icons
* `issue #74 <https://github.com/mayan-edms/mayan-edms/issues/74>`_ Cache a document's first document version
* `issue #75 <https://github.com/mayan-edms/mayan-edms/issues/75>`_ Move automatic OCR queueing from a configuration settings to a property of Document Type model
* `issue #77 <https://github.com/mayan-edms/mayan-edms/issues/77>`_ Add document view permission support to the search app
* `issue #78 <https://github.com/mayan-edms/mayan-edms/issues/78>`_ COMMON_TEMPORARY_DIRECTORY seems not to be used everywhere
* `issue #79 <https://github.com/mayan-edms/mayan-edms/issues/79>`_ Error installing
* `issue #82 <https://github.com/mayan-edms/mayan-edms/issues/82>`_ Make document type a required field
* `issue #83 <https://github.com/mayan-edms/mayan-edms/issues/83>`_ Simplify source app views and navigation
* `issue #84 <https://github.com/mayan-edms/mayan-edms/issues/84>`_ Remove template context variable 'object_name' to improve translations
* `issue #85 <https://github.com/mayan-edms/mayan-edms/issues/85>`_ Reset page count for a single document
* `issue #86 <https://github.com/mayan-edms/mayan-edms/issues/86>`_ Move migrations to new 'south_migrations' folders
* `issue #87 <https://github.com/mayan-edms/mayan-edms/issues/87>`_ Per document language selection
* `issue #88 <https://github.com/mayan-edms/mayan-edms/issues/88>`_ Remove metadata type selection from the upload wizard
* `issue #89 <https://github.com/mayan-edms/mayan-edms/issues/89>`_ Allow metadata types to be required for specific document types
* `issue #90 <https://github.com/mayan-edms/mayan-edms/issues/90>`_ Remove the app_registry app
* `issue #91 <https://github.com/mayan-edms/mayan-edms/issues/91>`_ Don't preserve the ?page= URL query string value when switching sources during document upload
* `issue #92 <https://github.com/mayan-edms/mayan-edms/issues/92>`_ Make register_multi_item_links class aware
* `issue #95 <https://github.com/mayan-edms/mayan-edms/issues/95>`_ Installation error on Mac OSX; OSError: [Errno 2] No such file or directory
* `issue #96 <https://github.com/mayan-edms/mayan-edms/issues/96>`_ Remove hard code User model references
* `issue #97 <https://github.com/mayan-edms/mayan-edms/issues/97>`_ Make multi item links a drop down list
* `issue #104 <https://github.com/mayan-edms/mayan-edms/issues/104>`_ Finish polishing metadata validation patch
* `issue #105 <https://github.com/mayan-edms/mayan-edms/issues/105>`_ Tie smart links setups to document types
* `issue #106 <https://github.com/mayan-edms/mayan-edms/issues/106>`_ Convert document indexing app actions to Celery
* `issue #107 <https://github.com/mayan-edms/mayan-edms/issues/107>`_ Restrict document metadata addition and removal
* `issue #108 <https://github.com/mayan-edms/mayan-edms/issues/108>`_ New home screen
* `issue #109 <https://github.com/mayan-edms/mayan-edms/issues/109>`_ Add Roles API endpoints
* `issue #111 <https://github.com/mayan-edms/mayan-edms/issues/111>`_ Add Checkouts API endpoints
* `issue #112 <https://github.com/mayan-edms/mayan-edms/issues/112>`_ Add OCR API endpoints
* `issue #114 <https://github.com/mayan-edms/mayan-edms/issues/114>`_ Implement UI language as user preference
* `issue #116 <https://github.com/mayan-edms/mayan-edms/issues/116>`_ Add documentation topic explicitly noting the binary requirements
* `issue #118 <https://github.com/mayan-edms/mayan-edms/issues/118>`_ When a metadata type is removed from a document type, remove it from all the documents of that type
* `issue #119 <https://github.com/mayan-edms/mayan-edms/issues/119>`_ When a required metadata type is added to a document type, add it to all documents of that type
* `issue #126 <https://github.com/mayan-edms/mayan-edms/issues/126>`_ Failing migration with SQLite
* `issue #127 <https://github.com/mayan-edms/mayan-edms/issues/127>`_ Failing migration with Postgres
* `issue #128 <https://github.com/mayan-edms/mayan-edms/issues/128>`_ Add Indexes API endpoints
* `issue #129 <https://github.com/mayan-edms/mayan-edms/issues/129>`_ Search api shouldn't memorize requested page as part of the query
* `issue #130 <https://github.com/mayan-edms/mayan-edms/issues/130>`_ Users API is not working correctly
* `issue #131 <https://github.com/mayan-edms/mayan-edms/issues/131>`_ Is there an API to update a user's password?
* `issue #137 <https://github.com/mayan-edms/mayan-edms/issues/137>`_ Enhancement of language selection
* `issue #138 <https://github.com/mayan-edms/mayan-edms/issues/138>`_ Possibility to keep zoom factor
* `issue #139 <https://github.com/mayan-edms/mayan-edms/issues/139>`_ Translatability of language selection
* `issue #140 <https://github.com/mayan-edms/mayan-edms/issues/140>`_ Thumbnail creation for ods crashing
* `issue #143 <https://github.com/mayan-edms/mayan-edms/issues/143>`_ Exception Value: 'exceptions.ValueError' object has no attribute 'messages'
* `issue #144 <https://github.com/mayan-edms/mayan-edms/issues/144>`_ Behavior of 'Edit metadata' (Recent Documents)
* `issue #146 <https://github.com/mayan-edms/mayan-edms/issues/146>`_ Periodic task not initiated for mail boxes and watch folders
* `issue #149 <https://github.com/mayan-edms/mayan-edms/issues/149>`_ Attribute error in document download
* `issue #150 <https://github.com/mayan-edms/mayan-edms/issues/150>`_ Double second menu entry
* `issue #152 <https://github.com/mayan-edms/mayan-edms/issues/152>`_ Document content empty
* `issue #153 <https://github.com/mayan-edms/mayan-edms/issues/153>`_ south migration with postgres: documents: 031_remove_orphan_documents
* `issue #154 <https://github.com/mayan-edms/mayan-edms/issues/154>`_ south migration with postgres: tags: 0002_auto__add_tag__chg_field_tagproperties_tag
* `issue #157 <https://github.com/mayan-edms/mayan-edms/issues/157>`_ upload new version of a document not working
* `issue #158 <https://github.com/mayan-edms/mayan-edms/issues/158>`_ Plural form not matching singular form in ocr app bug i18n
* :github-issue:`30` Document workflows
* :github-issue:`32` Watched folders
* :github-issue:`34` Postprocessing document queue
* :github-issue:`35` Metadata validation
* :github-issue:`37` Add from __future__ import unicode_literals
* :github-issue:`39` Capitalization of messages
* :github-issue:`40` Update references to root ('/') path
* :github-issue:`46` Advanced search past 1st page
* :github-issue:`49` Problems with large pdf files
* :github-issue:`50` raise CommandNotFound(path)
* :github-issue:`51` Search with ANONYMOUS error
* :github-issue:`55` Document approval cicle?
* :github-issue:`56` Removal of non essential features, views, models
* :github-issue:`57` Migrate to Celery for task query and periodic tasks
* :github-issue:`64` Pluralize messages properly
* :github-issue:`65` Backport the ability to receive documents via email
* :github-issue:`66` Python 3 compatibility: Add from __future__ import unicode_literals and remove all u''
* :github-issue:`68` Revise and update the use gettext vs. gettext_lazy
* :github-issue:`69` Feature removal: remove "Unregistered" message from the title bar
* :github-issue:`71` Add retry support to the converter task
* :github-issue:`72` Delete unused static icons
* :github-issue:`74` Cache a document's first document version
* :github-issue:`75` Move automatic OCR queueing from a configuration settings to a property of Document Type model
* :github-issue:`77` Add document view permission support to the search app
* :github-issue:`78` COMMON_TEMPORARY_DIRECTORY seems not to be used everywhere
* :github-issue:`79` Error installing
* :github-issue:`82` Make document type a required field
* :github-issue:`83` Simplify source app views and navigation
* :github-issue:`84` Remove template context variable 'object_name' to improve translations
* :github-issue:`85` Reset page count for a single document
* :github-issue:`86` Move migrations to new 'south_migrations' folders
* :github-issue:`87` Per document language selection
* :github-issue:`88` Remove metadata type selection from the upload wizard
* :github-issue:`89` Allow metadata types to be required for specific document types
* :github-issue:`90` Remove the app_registry app
* :github-issue:`91` Don't preserve the ?page= URL query string value when switching sources during document upload
* :github-issue:`92` Make register_multi_item_links class aware
* :github-issue:`95` Installation error on Mac OSX; OSError: [Errno 2] No such file or directory
* :github-issue:`96` Remove hard code User model references
* :github-issue:`97` Make multi item links a drop down list
* :github-issue:`104` Finish polishing metadata validation patch
* :github-issue:`105` Tie smart links setups to document types
* :github-issue:`106` Convert document indexing app actions to Celery
* :github-issue:`107` Restrict document metadata addition and removal
* :github-issue:`108` New home screen
* :github-issue:`109` Add Roles API endpoints
* :github-issue:`111` Add Checkouts API endpoints
* :github-issue:`112` Add OCR API endpoints
* :github-issue:`114` Implement UI language as user preference
* :github-issue:`116` Add documentation topic explicitly noting the binary requirements
* :github-issue:`118` When a metadata type is removed from a document type, remove it from all the documents of that type
* :github-issue:`119` When a required metadata type is added to a document type, add it to all documents of that type
* :github-issue:`126` Failing migration with SQLite
* :github-issue:`127` Failing migration with Postgres
* :github-issue:`128` Add Indexes API endpoints
* :github-issue:`129` Search api shouldn't memorize requested page as part of the query
* :github-issue:`130` Users API is not working correctly
* :github-issue:`131` Is there an API to update a user's password?
* :github-issue:`137` Enhancement of language selection
* :github-issue:`138` Possibility to keep zoom factor
* :github-issue:`139` Translatability of language selection
* :github-issue:`140` Thumbnail creation for ods crashing
* :github-issue:`143` Exception Value: 'exceptions.ValueError' object has no attribute 'messages'
* :github-issue:`144` Behavior of 'Edit metadata' (Recent Documents)
* :github-issue:`146` Periodic task not initiated for mail boxes and watch folders
* :github-issue:`149` Attribute error in document download
* :github-issue:`150` Double second menu entry
* :github-issue:`152` Document content empty
* :github-issue:`153` south migration with postgres: documents: 031_remove_orphan_documents
* :github-issue:`154` south migration with postgres: tags: 0002_auto__add_tag__chg_field_tagproperties_tag
* :github-issue:`157` upload new version of a document not working
* :github-issue:`158` Plural form not matching singular form in ocr app bug i18n
.. _Celery: http://www.celeryproject.org/

52
docs/releases/2.0.1.rst
View File

@@ -1,31 +1,34 @@
===============================
Mayan EDMS v2.0.1 release notes
===============================
Version 2.0.1
=============
Released: January 22, 2016
Welcome to Mayan EDMS v2.0.1
What's new in Mayan EDMS v2.0.1
===============================
Changes
-------
Required metadata was not enforce correctly
-------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Fixed a situation where documents having required metadata could still be
uploaded without entering a value for the required metadata.
Fix multiple document metadata adding
-------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Fixed a bug when adding metadata to multiple documents.
Fix multiple document metadata editing
--------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Fixed a bug that made it impossible to edit multiple documents' metadata values
if one of the documents had no previous value for it's metadata.
Updated Vagrant file
--------------------
^^^^^^^^^^^^^^^^^^^^
The included Vagrant file now provide 2 boxes: development and production.
Selection which kind of box to provision is as easy as executing::
@@ -37,18 +40,22 @@ or
Other changes
-------------
^^^^^^^^^^^^^
* None
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -56,8 +63,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -71,8 +79,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -86,14 +95,15 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #243 <https://gitlab.com/mayan-edms/mayan-edms/issues/243>`_ System allows a user to skip entering values for a required metadata field while uploading a new document
* `GitLab issue #245 <https://gitlab.com/mayan-edms/mayan-edms/issues/245>`_ Add multiple metadata not possible
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`243` System allows a user to skip entering values for a required metadata field while uploading a new document
* :gitlab-issue:`245` Add multiple metadata not possible
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

49
docs/releases/2.0.2.rst
View File

@@ -1,34 +1,39 @@
===============================
Mayan EDMS v2.0.2 release notes
===============================
Version 2.0.2
=============
Released: February 15, 2016
Welcome to Mayan EDMS v2.0.2
What's new
==========
Changes
-------
Fine tune "Update" checkbox from the metadata entry form
--------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Previously the update checkbox was ignored during the metadata step of the
document upload wizard with the wizard always creating a metadata entry for the
new document even if the entry was left blank. The checkbox now controls whether
or not the wizard will store try to create the metadata entry.
Fix empty optional lookup metadata fields behavior
--------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
An edge case was fixed that caused validation to be executed for empty metadata
fields that had a value lookup list.
Remove Docker files
-------------------
^^^^^^^^^^^^^^^^^^^
Included Docker and Docker Compose files were removed since the Mayan EDMS Docker
(https://gitlab.com/mayan-edms/mayan-edms-docker) repository is stable.
Other changes
-------------
- Only extract validation error messages from ValidationError exception instances.
^^^^^^^^^^^^^
- Only extract validation error messages from ``ValidationError`` exception
instances.
- Add 2 second delay to document version tests to workaround MySQL not storing
the millisecond part of the document version's timestamp.
- Install testing dependencies when installing development dependencies.
@@ -36,15 +41,18 @@ Other changes
- Move metadata form value validation to .clean() method.
- Add HTML tags stripping to the browser title generation template.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -52,8 +60,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -67,8 +76,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -82,13 +92,14 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #250 <https://gitlab.com/mayan-edms/mayan-edms/issues/250>`_ Empty optional lookup metadata trigger validation error.
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`250` Empty optional lookup metadata trigger validation error.
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

317
docs/releases/2.0.rst
View File

File diff suppressed because it is too large Load Diff

42
docs/releases/2.1.1.rst
View File

@@ -1,41 +1,46 @@
===============================
Mayan EDMS v2.1.1 release notes
===============================
Version 2.1.1
=============
Released: May 17, 2016
What's new
==========
This is a bugfix release and all users are encouraged to upgrade.
Changes
-------
Fix object column resolution issue in navigation app
----------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Version 2.1 includes a navigation feature that allows model instances from a
queryset generated using the .defer() or .only() Django filter optimization
features to resolve to their parent class transparently. This optimization
caused problems with the sources app which uses a
Missing Tesseract language files
--------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Tesseract OCR backend now reports if the tesseract language file is missing
for the requested document's language.
Other changes
-------------
^^^^^^^^^^^^^
- Ensure the automatic default index is created after the default document type.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -43,8 +48,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -58,8 +64,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -73,15 +80,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #288 <https://gitlab.com/mayan-edms/mayan-edms/issues/288>`_ Can't add sources in mayan-edms 2.1.
* `GitLab issue #289 <https://gitlab.com/mayan-edms/mayan-edms/issues/289>`_ OCR fails with Exception.
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`288` Can't add sources in mayan-edms 2.1.
* :gitlab-issue:`289` OCR fails with Exception.
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

26
docs/releases/2.1.10.rst
View File

@@ -1,31 +1,30 @@
================================
Mayan EDMS v2.1.10 release notes
================================
Version 2.1.10
==============
Released: February 13, 2017
What's new
==========
This is a micro release equal to the previews version from the user's point of view.
The version number was increase to workaround some issues with the Python
Package Index not allowing re-uploads.
Changes
-------------
-------
- Update Makefile to use twine for releases.
- Add Makefile target to make test releases.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -33,8 +32,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -48,8 +48,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -63,12 +64,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

36
docs/releases/2.1.11.rst
View File

@@ -1,17 +1,13 @@
================================
Mayan EDMS v2.1.11 release notes
================================
Version 2.1.11
==============
Released: March 14, 2017
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade. The focus
of this micro release was REST API improvement.
Changes
-------------
-------
- Added a quick rename serializer to the document type API serializer.
- Added per document type, workflow list API view. The URL for this endpoint is
@@ -24,7 +20,7 @@ Changes
- Implemented document workflows transition ACLs. GitLab issue #321.
- Add document comments API endpoints. GitHub issue #249.
- Add support for overriding the Celery class. The setting is named
MAYAN_CELERY_CLASS and expects a dotted python path to the class to use.
``MAYAN_CELERY_CLASS`` and expects a dotted python path to the class to use.
- Changed the document upload view in source app to not use the HTTP referer
URL blindly, but instead recompose the URL using known view name. Needed
when integrating Mayan EDMS into other app via using iframes.
@@ -34,15 +30,18 @@ Changes
- Added support for adding or editing document types to smart links via the
API.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -50,8 +49,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -65,8 +65,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -80,15 +81,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `Github issue #249 <https://github.com/mayan-edms/mayan-edms/issues/249>`_ Add document comments API [$50 US]
* `GitLab issue #321 <https://gitlab.com/mayan-edms/mayan-edms/issues/321>`_ Transition ACLS
* `GitLab issue #357 <https://gitlab.com/mayan-edms/mayan-edms/issues/357>`_ It should be possible to retrieve all workflows for a given DocumentType from the API
Bugs fixed or issues closed
---------------------------
* :github-issue:`355` Add document comments API [$50 US]
* :gitlab-issue:`321` Transition ACLS
* :gitlab-issue:`357` It should be possible to retrieve all workflows for a given DocumentType from the API
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

41
docs/releases/2.1.2.rst
View File

@@ -1,40 +1,45 @@
===============================
Mayan EDMS v2.1.2 release notes
===============================
Version 2.1.2
=============
Released: May 20, 2016
What's new
==========
This is a bugfix release and all users are encouraged to upgrade.
Changes
-------
Language list sorting
---------------------
^^^^^^^^^^^^^^^^^^^^^
The document language list and the user locale profile language list are now
sorted to make it easier to find the desired language.
Fixed the metadata lookup options: {{ users }} and {{ groups }}
---------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When configuring metadata type lookup options the {{ users }} and {{ groups }}
special options can be used to display a list of users or a list of groups.
These options where producing a list in the wrong format and were updated.
Other changes
-------------
^^^^^^^^^^^^^
- Add Makefile for common development tasks
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -42,8 +47,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -57,8 +63,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -72,15 +79,15 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #290 <https://gitlab.com/mayan-edms/mayan-edms/issues/290>`_ Unicode characters not supported as metadata values
* `GitLab issue #292 <https://gitlab.com/mayan-edms/mayan-edms/issues/292>`_ Sort languages by name not by abbreviation
---------------------------
* :gitlab-issue:`290` Unicode characters not supported as metadata values
* :gitlab-issue:`292` Sort languages by name not by abbreviation
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

40
docs/releases/2.1.3.rst
View File

@@ -1,24 +1,26 @@
===============================
Mayan EDMS v2.1.3 release notes
===============================
Version 2.1.3
=============
Released: June 29, 2016
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade.
Changes
-------
Temporary files cleanup
-----------------------
^^^^^^^^^^^^^^^^^^^^^^^
When uploading PDF files that had been OCRed by previous software, the text
parser backend that uses Poppler, would leave behind some temporary files in
the /tmp folder. The issue has been resolved and from the fix a test mixin
system check has been devised that will identify places in the codebase with
similar behaviors, reducing the recurrence of similar issues in the future.
Other changes
-------------
^^^^^^^^^^^^^
- Add help message when initialsetup migration phase fails. Relates to GitLab issue #296
- Start using self.setdout instead of print as per documentation.
- Fix GitLab issue #295, "When editing a user the top bar jumps to the name of the user".
@@ -27,15 +29,18 @@ Other changes
- Add missing temporary file cleanup for office documents.
- Fix file descriptor leak in the document signature download test.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -43,8 +48,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -58,8 +64,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -73,15 +80,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #295 <https://gitlab.com/mayan-edms/mayan-edms/issues/295>`_ When editing a user the top bar jumps to the name of the user
* `GitLab issue #309 <https://gitlab.com/mayan-edms/mayan-edms/issues/309>`_ Temp files quickly filling-up my /tmp (1GB tmpfs)
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`295` When editing a user the top bar jumps to the name of the user
* :gitlab-issue:`309` Temp files quickly filling-up my /tmp (1GB tmpfs)
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

37
docs/releases/2.1.4.rst
View File

@@ -1,16 +1,13 @@
===============================
Mayan EDMS v2.1.4 release notes
===============================
Version 2.1.4
=============
Released: October 28, 2016
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade.
Other changes
-------------
Changes
-------
- Fix statistics namespace list display view
- Fix events list display view
- Update required Django version to 1.8.15
@@ -21,15 +18,18 @@ Other changes
- New GPG backend system
- Minor documentation updates
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -37,8 +37,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -52,8 +53,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -67,15 +69,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #311 <https://gitlab.com/mayan-edms/mayan-edms/issues/311>`_ acl page return ContentType:Document
* `GitLab issue #316 <https://gitlab.com/mayan-edms/mayan-edms/issues/316>`_ Error when trying to access the statistics
* `GitLab issue #324 <https://gitlab.com/mayan-edms/mayan-edms/issues/324>`_ Document signature tests fail in Ubuntu 16.10
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`311` acl page return ContentType:Document
* :gitlab-issue:`316` Error when trying to access the statistics
* :gitlab-issue:`324` Document signature tests fail in Ubuntu 16.10
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

39
docs/releases/2.1.5.rst
View File

@@ -1,16 +1,12 @@
===============================
Mayan EDMS v2.1.5 release notes
===============================
Version 2.1.5
=============
Released: November 8, 2016
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade.
Other changes
-------------
Changes
-------
- Backport resize transformation math operation fix (GitLab #319).
- Update Pillow to 3.1.2
@@ -24,15 +20,18 @@ Other changes
- Fix ACL create view HTML response type. (GitLab #335).
- Expland staging folder and watch folder explanation.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -40,8 +39,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -55,8 +55,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -70,18 +71,18 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #319 <https://gitlab.com/mayan-edms/mayan-edms/issues/319>`_ TransformationResize issue with very "long" image
* `GitLab issue #331 <https://gitlab.com/mayan-edms/mayan-edms/issues/331>`_ Trash List View: Items actions should be limited
* `GitLab issue #333 <https://gitlab.com/mayan-edms/mayan-edms/issues/333>`_ "Unable to run gpg - it may not be available."
* `GitLab issue #334 <https://gitlab.com/mayan-edms/mayan-edms/issues/334>`_ Perfomance improvment: prevent unnecessary image.resize in TransformationZoom
* `GitLab issue #335 <https://gitlab.com/mayan-edms/mayan-edms/issues/335>`_ Wrong HTML Content-Type in ACL->NEW
---------------------------
* :gitlab-issue:`319` TransformationResize issue with very "long" image
* :gitlab-issue:`331` Trash List View: Items actions should be limited
* :gitlab-issue:`333` "Unable to run gpg - it may not be available."
* :gitlab-issue:`334` Perfomance improvment: prevent unnecessary image.resize in TransformationZoom
* :gitlab-issue:`335` Wrong HTML Content-Type in ACL->NEW
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

26
docs/releases/2.1.6.rst
View File

@@ -1,29 +1,28 @@
===============================
Mayan EDMS v2.1.6 release notes
===============================
Version 2.1.6
=============
Released: November 23, 2016
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade.
Changes
-------------
-------
- Fix variable name typo in the rotation transformation class.
- Update translations
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -31,8 +30,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -46,8 +46,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -61,12 +62,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

26
docs/releases/2.1.7.rst
View File

@@ -1,17 +1,13 @@
===============================
Mayan EDMS v2.1.7 release notes
===============================
Version 2.1.7
=============
Released: February 2, 2017
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade. The focus
of this micro release was REST API improvement.
Changes
-------------
-------
- Improved user management API endpoints (initial work by @lokeshmanmode):
@@ -44,15 +40,18 @@ Changes
- The parser and validation fields of the metadata type model have been enable
in the metadata type API serializer.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -60,8 +59,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -75,8 +75,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -90,12 +91,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

34
docs/releases/2.1.8.rst
View File

@@ -1,17 +1,13 @@
===============================
Mayan EDMS v2.1.8 release notes
===============================
Version 2.1.8
=============
Released: February 12, 2017
What's new
==========
This is a bug-fix release and all users are encouraged to upgrade. The focus
of this micro release was REST API improvement.
Changes
-------------
-------
- Fixes in the trashed document API endpoints.
- Improved tags API PUT and PATCH endpoints.
@@ -23,15 +19,18 @@ Changes
- Add Smart link API endpoints.
- Add writable versions of the Document and Document Type serializers (GitLab issues #348 and #349).
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -39,8 +38,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -54,8 +54,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -69,15 +70,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #310 <https://gitlab.com/mayan-edms/mayan-edms/issues/310>`_ Metadata's lookup with chinese messages when new document
* `GitLab issue #348 <https://gitlab.com/mayan-edms/mayan-edms/issues/348>`_ REST API: Document version comments are not getting updated
* `GitLab issue #349 <https://gitlab.com/mayan-edms/mayan-edms/issues/349>`_ REST API: Document Label, Description are not able to update
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`310` Metadata's lookup with chinese messages when new document
* :gitlab-issue:`348` REST API: Document version comments are not getting updated
* :gitlab-issue:`349` REST API: Document Label, Description are not able to update
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

27
docs/releases/2.1.9.rst
View File

@@ -1,30 +1,30 @@
===============================
Mayan EDMS v2.1.9 release notes
===============================
Version 2.1.9
=============
Released: February 13, 2017
What's new
==========
This is a micro release equal to the previews version from the user's point of view.
The version number was increase to workaround some issues with the Python
Package Index not allowing re-uploads.
Changes
-------------
-------
- Update make file to Workaround long standing pypa wheel bug #99
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -32,8 +32,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -47,8 +48,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -62,12 +64,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

131
docs/releases/2.1.rst
View File

@@ -1,14 +1,14 @@
=============================
Mayan EDMS v2.1 release notes
=============================
Version 2.1
===========
Released: May 14, 2016
What's new
==========
Changes
-------
Upgrade to use Django 1.8.13
----------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
With the end of life support for Django 1.7, moving to the next Mayan EDMS
minor version was a target for this release. The Django minor release chosen was
1.8 as it is very compatible with 1.7 and required minimal changes. Django 1.8
@@ -16,28 +16,35 @@ is an LTS release (Long Term Support) meaning that is no new big feature of a
new Django version is required, the project can stay in Django 1.8 for a good
amount of time with no downsides.
Remove remaining references to Django's User model
--------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The few remaining hard code references to Django's User model that were missed
in a previous release have been removed. Using a custom User model with Mayan
should present very little if any obstacles.
Remove included login required middleware
-----------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The custom middleware include with Mayan EDMS that forces user to be
authenticated before being able to access any view has been removed in favor of
a dedicated 3rd party Django app for that purpose. The app chosen was
django-stronghold (http://mikegrouchy.com/django-stronghold/).
Improve generation of success and error messages for class based views
----------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In the past success messages for actions would show a generic mention to the
object being manipulated (document, folder, tag). Now the errors and success
messages with be more explicit in describing what the view has or was trying
to manipulate.
Remove ownership concept from folders
-------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Currently Folders in Mayan EDMS have a field that stores a reference to the
user that has created that folders. One of the design decisions of Mayan EDMS
is that there should never be any explicit ownership of any object. Ownership
@@ -45,8 +52,10 @@ is relative and is defined by the Access Control List of an object. The
removal of the user field from the Folders model brings this app in line with
the defined behavior.
Replacement of strip_spaces middleware with the spaceless template tag
----------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
As a size optimization technique HTML content was dynamically stripped of spaces
as it was being served. The technique used involved detecting the MIME type of
the content being served and if found to be of text/HTML type spaces between
@@ -57,50 +66,64 @@ when the template is compiled and not at each HTTP response. The optimization
is minimal but since it happened at every response a small increase in speed
is expected for all deployment scenarios.
Deselect the update checkbox for optional metadata by default
-------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
During the last releases the behavior of the of metadata edit checkbox has seen
several tune ups. Thanks to community feedback one small change has been
introduced. The edit checkbox will be deselected by default for all optional
document type metadata entries.
Implement per document type document creation permission
--------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If is now possible to grant the document creation permission to a role for a
document type. Previously document creation was a "blanket" permission. Having
the permission meant that user could create any type of document. With this
change it is now possible to restrict which types of document users of a
specific role can create.
Make document type delete time period optional
----------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The entries that defined after how long a document in the trash would be
permanently deleted have been made optional. This means that if a document
type has this option blank, the corresponding document of this type would never
be deleted from the trash can.
Fixed date locale handling in document properties, checkout and user detail views
---------------------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A few releases back the ability to for users to set their timezone was added.
This change also included a smart date rendering update to adjust the dates
and times fields to the user's timezone. Some users reported a few views where
this timezone adjustment was not happening, this has been fully fixed.
Default index
-------------
^^^^^^^^^^^^^
During new installations a default index that organizes document by year/month
when they were uploaded will be created to help users better understand the
concept of indexes in Mayan EDMS.
HTML5 upload widget
-------------------
^^^^^^^^^^^^^^^^^^^
A common request is the ability to just drap and drop documents from other
windows into Mayan EDMS's document upload wizard. This release includes that
capability and will also show a completion bar for the upload. Document
uploading is sped up dramatically with this change.
Message of the Day app
----------------------
^^^^^^^^^^^^^^^^^^^^^^
Administrators wanting to display announcements has no other way to do so
than to customize the login template. To avoid this a new app has been added
that allows for the creation of messages to be shown at the user login
@@ -108,8 +131,10 @@ screen. These messages can have an activation and an expiration date and
time. These messages are useful for display company access policies,
maintenance announcement, etc.
Document signing
----------------
^^^^^^^^^^^^^^^^
The biggest change for this release if the addition of document signing from
within the UI. Enterprise users request this feature very often as in those
environments cryptographic signatures are a basic requirement. Previously
@@ -129,8 +154,10 @@ Finally documents are now checked just once for signatures and not every time
they are accessed, this provides a very sizable speed improvement in document
access and availability.
Other changes
=============
^^^^^^^^^^^^^
- Upgrade Python requirements to recent versions.
- Rename 'Content' search box to 'OCR'.
- Silence all Django 1.8 model import warnings.
@@ -161,11 +188,12 @@ Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -173,8 +201,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -188,8 +217,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -203,36 +233,37 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #137 <https://gitlab.com/mayan-edms/mayan-edms/issues/137>`_ Add app creation chapter to documentation.
* `GitLab issue #147 <https://gitlab.com/mayan-edms/mayan-edms/issues/147>`_ Add in app document signing.
* `GitLab issue #161 <https://gitlab.com/mayan-edms/mayan-edms/issues/161>`_ Email backend setup documentation.
* `GitLab issue #162 <https://gitlab.com/mayan-edms/mayan-edms/issues/162>`_ Add HTML5 file uploader.
* `GitLab issue #191 <https://gitlab.com/mayan-edms/mayan-edms/issues/191>`_ Split index contents title into title and path/breadcrumb widget.
* `GitLab issue #206 <https://gitlab.com/mayan-edms/mayan-edms/issues/206>`_ Support for dynamic LOGIN_EXEMPT_URLS.
* `GitLab issue #208 <https://gitlab.com/mayan-edms/mayan-edms/issues/208>`_ Add tagging step to upload wizard.
* `GitLab issue #218 <https://gitlab.com/mayan-edms/mayan-edms/issues/218>`_ Cookie cutter template for Mayan apps.
* `GitLab issue #222 <https://gitlab.com/mayan-edms/mayan-edms/issues/222>`_ Add notice board or Message of the Day.
* `GitLab issue #225 <https://gitlab.com/mayan-edms/mayan-edms/issues/225>`_ Remove hard coded User model.
* `GitLab issue #232 <https://gitlab.com/mayan-edms/mayan-edms/issues/232>`_ "Create documents" is a blanket permission for a user to create a document of any document type.
* `GitLab issue #246 <https://gitlab.com/mayan-edms/mayan-edms/issues/246>`_ Upgrade to Django version 1.8 as Django 1.7 is end-of-life.
* `GitLab issue #251 <https://gitlab.com/mayan-edms/mayan-edms/issues/251>`_ Add method to disable metadata edit form "update" checkbox when not needed.
* `GitLab issue #255 <https://gitlab.com/mayan-edms/mayan-edms/issues/255>`_ UnicodeDecodeError in apps/common/middleware/strip_spaces_widdleware.py.
* `GitLab issue #256 <https://gitlab.com/mayan-edms/mayan-edms/issues/256>`_ typo in locale settings (Dutch).
* `GitLab issue #261 <https://gitlab.com/mayan-edms/mayan-edms/issues/261>`_ Feature: Document Access Audit Logging.
* `GitLab issue #265 <https://gitlab.com/mayan-edms/mayan-edms/issues/265>`_ Indexes show list (show indexe only if the user has ACLs on document type).
* `GitLab issue #266 <https://gitlab.com/mayan-edms/mayan-edms/issues/266>`_ Smart links : Dynamic label with Postgresql.
* `GitLab issue #267 <https://gitlab.com/mayan-edms/mayan-edms/issues/267>`_ Release 2.1 RC1 : Notes and ideas.
* `GitLab issue #268 <https://gitlab.com/mayan-edms/mayan-edms/issues/268>`_ Release 2.1 RC1 : Bug to access inside an indexes.
* `GitLab issue #270 <https://gitlab.com/mayan-edms/mayan-edms/issues/270>`_ Release 2.1 RC1 : Bug statistics.
* `GitLab issue #274 <https://gitlab.com/mayan-edms/mayan-edms/issues/274>`_ [Release 2.1 RC2] Web Tests.
* `GitLab issue #275 <https://gitlab.com/mayan-edms/mayan-edms/issues/275>`_ [Release 2.1 RC2] Notes.
* `GitLab issue #276 <https://gitlab.com/mayan-edms/mayan-edms/issues/276>`_ [Release 2.1 RC2] API Tests.
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`137` Add app creation chapter to documentation.
* :gitlab-issue:`147` Add in app document signing.
* :gitlab-issue:`161` Email backend setup documentation.
* :gitlab-issue:`162` Add HTML5 file uploader.
* :gitlab-issue:`191` Split index contents title into title and path/breadcrumb widget.
* :gitlab-issue:`206` Support for dynamic LOGIN_EXEMPT_URLS.
* :gitlab-issue:`208` Add tagging step to upload wizard.
* :gitlab-issue:`218` Cookie cutter template for Mayan apps.
* :gitlab-issue:`222` Add notice board or Message of the Day.
* :gitlab-issue:`255` Remove hard coded User model.
* :gitlab-issue:`232` "Create documents" is a blanket permission for a user to create a document of any document type.
* :gitlab-issue:`246` Upgrade to Django version 1.8 as Django 1.7 is end-of-life.
* :gitlab-issue:`251` Add method to disable metadata edit form "update" checkbox when not needed.
* :gitlab-issue:`255` UnicodeDecodeError in apps/common/middleware/strip_spaces_widdleware.py.
* :gitlab-issue:`256` typo in locale settings (Dutch).
* :gitlab-issue:`261` Feature: Document Access Audit Logging.
* :gitlab-issue:`265` Indexes show list (show indexe only if the user has ACLs on document type).
* :gitlab-issue:`266` Smart links : Dynamic label with Postgresql.
* :gitlab-issue:`267` Release 2.1 RC1 : Notes and ideas.
* :gitlab-issue:`268` Release 2.1 RC1 : Bug to access inside an indexes.
* :gitlab-issue:`270` Release 2.1 RC1 : Bug statistics.
* :gitlab-issue:`274` [Release 2.1 RC2] Web Tests.
* :gitlab-issue:`275` [Release 2.1 RC2] Notes.
* :gitlab-issue:`276` [Release 2.1 RC2] API Tests.
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

127
docs/releases/2.2.rst
View File

@@ -1,14 +1,14 @@
=============================
Mayan EDMS v2.2 release notes
=============================
Version 2.2
===========
Released: April 26, 2017
What's new
==========
Changes
-------
API changes
-----------
^^^^^^^^^^^
Refactor of the metadata API URLs to use the resource/sub resource paradigm.
Before:
@@ -66,8 +66,10 @@ resolved to '/api/documents/<pk>/pages/<page_pk>/pages'.
- API endpoint to view or change a role's groups.
- API endpoint to view or change a role's permissions.
Code cleanups
-------------
^^^^^^^^^^^^^
As with every release time was dedicated to improve the organization, size, and
readability of code. To this end the licenses of each app were moved to their
own module in every app, called licenses.py. As part of the code cleanup the
@@ -76,8 +78,10 @@ installed alongside Mayan EDMS for debugging purposes has been removed. The
dependency on django-filetransfer has been removed by using
django-downloadviews which allows the creation of class based download views.
Performance
-----------
^^^^^^^^^^^
The document language list has been moved from the document model to the
document form. This change speeds up loading time, document properties views
and API documentation views. This version includes the new image caching
@@ -86,28 +90,36 @@ document's images resulting in an overall display loading speed up. The fonts
used are now loaded from Mayan EDMS itself and not from the web. This change
also allow Mayan EDMS to work in a completely off-line manner.
Searching
---------
^^^^^^^^^
Support for searching pages as well as documents has been added. This
functionality has been exposed in the API too.
Security
--------
^^^^^^^^
This release enables the password validation for the user password validation
support provided by Django. This change allows administrator to set password
policies limiting the minimum amount of characters needed for example. For
more information on how to configure the password validation feature refer
to Django's documentation at: https://docs.djangoproject.com/en/1.11/topics/auth/passwords/#enabling-password-validation
to the :django-docs:`topics/auth/passwords/#enabling-password-validation`
Sources
-------
^^^^^^^
To help test the interval sources (POP3 Email, IMAP Email, Watch folders) a
"Check now" button was added that allows users to trigger the source's
document fetching code instantly. Previously users had to wait until the next
scheduled interval to verify if their source's settings were correct.
Testing
-------
^^^^^^^
The testing process has been simplified by adding a new option '--mayan-apps'
to the test runner that automatically tests all Mayan EDMS apps that report to
include tests. The app flag that indicates when an app has test was changed
@@ -118,11 +130,13 @@ to 81%.
A custom test runner replacing the previous custom management command
called `runtests`. Testing for orphaned temporary files and orphaned file
handles is now optional and controlled by the COMMON_TEST_FILE_HANDLES and
COMMON_TEST_FILE_HANDLES settings.
handles is now optional and controlled by the ``COMMON_TEST_FILE_HANDLES`` and
``COMMON_TEST_FILE_HANDLES`` settings.
User interface
--------------
^^^^^^^^^^^^^^
To avoid warping on long full names or usernames, the user's full name or
username is no longer displayed in the main menu. Instead the word "Profile"
is displayed and the users's full name or username is displayed when the
@@ -141,8 +155,10 @@ A new workflow view that lists documents currently executing a workflow and
documents by their specific current workflow state has been added to the
main menu.
Other changes
-------------
^^^^^^^^^^^^^
- Cabinets app is now integrated as a core app.
- Now that the Cabinets app is included, the Folders app has been disabled
by default. To enable the Folders apps add the following line to your
@@ -156,17 +172,22 @@ Other changes
- Add support for attaching multiple tags to single or multiple documents.
- Refactor the workflow for removing tags from single and multiple documents.
- Move new version creation blocking from the documents app to the checkouts app.
- DEBUG now defaults to False.
- Production settings don't override the DEBUG variable. DEBUG can be set to True
on production install to debug errors live.
- Refactor add document to folder view to allow adding a documents to multiple folders at the same time.
- Refactor the remove document from folder view to allow removing documents from multiple folders at the same time.
- Refactor the document mailing views and add support for sending multiple documents via email at the same time.
- Refactor the document metadata views and add support for adding multiple metadata types to a document at the same time.
- Addition of a new OCR backend using PyOCR. This backend tries first to do OCR
using libtesseract. If libtesseract is not available the backend defaults to
calling the Tesseract executable.
- Make the lock_manager.backends.file_lock.FileLock the new default locking backend.
- ``DEBUG`` now defaults to ``False``.
- Production settings don't override the ``DEBUG`` variable. ``DEBUG`` can be
set to ``True`` on production install to debug errors live.
- Refactor add document to folder view to allow adding a documents to multiple
folders at the same time.
- Refactor the remove document from folder view to allow removing documents
from multiple folders at the same time.
- Refactor the document mailing views and add support for sending multiple
documents via email at the same time.
- Refactor the document metadata views and add support for adding multiple
metadata types to a document at the same time.
- Addition of a new OCR backend using ``PyOCR``. This backend tries first to
do OCR using ``libtesseract``. If ``libtesseract`` is not available the
backend defaults to calling the ``tesseract`` executable.
- Make the ``lock_manager.backends.file_lock.FileLock`` the new default
locking backend.
- New transformations added:
- Rotate 90 degrees
@@ -179,19 +200,22 @@ Other changes
- Add tool to launch all workflows. GitLab issue #355
Removals
--------
- Removal of the OCR_TESSERACT_PATH configuration setting.
- Removal of the Tesseract OCR backend. Replaced with a PyOCR backend.
- Removal of the ``OCR_TESSERACT_PATH`` configuration setting.
- Removal of the Tesseract OCR backend. Replaced with a ``PyOCR`` backend.
- Remove usage of pytesseract Python library.
- Installation app.
- Recent searches feature.
Upgrading from a previous version
---------------------------------
If installed via PIP
~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^
Type in the console::
@@ -199,8 +223,9 @@ Type in the console::
the requirements will also be updated automatically.
If installed using Git
~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -218,8 +243,9 @@ Remove deprecated requirements::
$ pip uninstall -y -r removals.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -233,26 +259,27 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #185 <https://gitlab.com/mayan-edms/mayan-edms/issues/185>`_ Add support for nested menus
* `GitLab issue #285 <https://gitlab.com/mayan-edms/mayan-edms/issues/285>`_ Dashboard widgets
* `GitLab issue #294 <https://gitlab.com/mayan-edms/mayan-edms/issues/294>`_ Move new version creation blocking from the documents app to the checkouts app
* `GitLab issue #301 <https://gitlab.com/mayan-edms/mayan-edms/issues/301>`_ Remove the installation app
* `GitLab issue #303 <https://gitlab.com/mayan-edms/mayan-edms/issues/303>`_ Update urlpatterns in urls.py files to be a list of django.conf.urls.url() instances instead.
* `GitLab issue #304 <https://gitlab.com/mayan-edms/mayan-edms/issues/304>`_ Remove string view arguments of url() in urls.py files.
* `GitLab issue #307 <https://gitlab.com/mayan-edms/mayan-edms/issues/307>`_ Enter multiple Tags at once
* `GitLab issue #310 <https://gitlab.com/mayan-edms/mayan-edms/issues/310>`_ Metadata's lookup with chinese messages when new document
* `GitLab issue #311 <https://gitlab.com/mayan-edms/mayan-edms/issues/311>`_ acl page return ContentType:Document
* `GitLab issue #319 <https://gitlab.com/mayan-edms/mayan-edms/issues/319>`_ TransformationResize issue with very "long" image
* `GitLab issue #328 <https://gitlab.com/mayan-edms/mayan-edms/issues/328>`_ Upgrade Warning/Error during performupgrade (v2.1.3 to v2.1.4)
* `GitLab issue #342 <https://gitlab.com/mayan-edms/mayan-edms/issues/342>`_ Tags should be of unordered / unsorted data type
* `GitLab issue #343 <https://gitlab.com/mayan-edms/mayan-edms/issues/343>`_ Bootstrap's dependency on fonts.googleapis.com causes Mayan EDMS web interface load slowly if public internet is unreachable
* `GitLab issue #355 <https://gitlab.com/mayan-edms/mayan-edms/issues/355>`_ Workflow changes only on new added documents
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`185` Add support for nested menus
* :gitlab-issue:`285` Dashboard widgets
* :gitlab-issue:`294` Move new version creation blocking from the documents app to the checkouts app
* :gitlab-issue:`301` Remove the installation app
* :gitlab-issue:`303` Update urlpatterns in urls.py files to be a list of django.conf.urls.url() instances instead.
* :gitlab-issue:`304` Remove string view arguments of url() in urls.py files.
* :gitlab-issue:`307` Enter multiple Tags at once
* :gitlab-issue:`310` Metadata's lookup with chinese messages when new document
* :gitlab-issue:`311` acl page return ContentType:Document
* :gitlab-issue:`319` TransformationResize issue with very "long" image
* :gitlab-issue:`328` Upgrade Warning/Error during performupgrade (v2.1.3 to v2.1.4)
* :gitlab-issue:`342` Tags should be of unordered / unsorted data type
* :gitlab-issue:`343` Bootstrap's dependency on fonts.googleapis.com causes Mayan EDMS web interface load slowly if public internet is unreachable
* :gitlab-issue:`355` Workflow changes only on new added documents
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

37
docs/releases/2.3.rst
View File

@@ -1,17 +1,14 @@
=============================
Mayan EDMS v2.3 release notes
=============================
Version 2.3
===========
Released: June 08, 2017
What's new
==========
This is a bug-fix and minor feature release and all users are encouraged to
upgrade.
Changes
-------------
-------
- Index node expression template field changed from a 128 character field to an
unlimited size text field to allow for complex indexing expressions.
- When updating the metadata of a document, any input in the value form field
@@ -40,15 +37,18 @@ Changes
can be accessed using {{ document.workflow.publish_workflow.get_current_state }}.
- Added a new API endpoint to display a list of all the available search models.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -56,8 +56,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -71,8 +72,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -86,16 +88,17 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #371 <https://gitlab.com/mayan-edms/mayan-edms/issues/371>`_ Auto select checkbox when updating metadata
* `GitLab issue #372 <https://gitlab.com/mayan-edms/mayan-edms/issues/372>`_ (Feature request) Allow 'rebuild index' to rebuild only a selected index
* `GitLab issue #383 <https://gitlab.com/mayan-edms/mayan-edms/issues/383>`_ Page not found when deployed to sub-uri
* `GitLab issue #385 <https://gitlab.com/mayan-edms/mayan-edms/issues/385>`_ mountindex: how to specify FUSE mount option allow_other?
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`371` Auto select checkbox when updating metadata
* :gitlab-issue:`372` (Feature request) Allow 'rebuild index' to rebuild only a selected index
* :gitlab-issue:`383` Page not found when deployed to sub-uri
* :gitlab-issue:`385` mountindex: how to specify FUSE mount option allow_other?
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

93
docs/releases/2.4.rst
View File

@@ -1,14 +1,14 @@
=============================
Mayan EDMS v2.4 release notes
=============================
Version 2.4
===========
Released: June 23, 2017
What's new
==========
Changes
-------
SANE document source
--------------------
^^^^^^^^^^^^^^^^^^^^
A new document source has been added with the ability to retrieve documents from
scanners directly. This new document source uses the SANE (Scanner Access Now Easy)
(https://en.wikipedia.org/wiki/Scanner_Access_Now_Easy) API client to communicate
@@ -16,26 +16,32 @@ with USB and network scanners. SANE must be properly installed for this document
source to work. Your scanner must also be supported by the SANE API
(http://www.sane-project.org/sane-supported-devices.html).
Automatic PDF orientation detection
-----------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The orientation of PDF documents is now detected at creation and a rotation
transformation applied to each of the document's pages to correct the orientation.
Environment variables
---------------------
^^^^^^^^^^^^^^^^^^^^^
Configuration options can now be updated from environment variables. To update
a configuration option, prepend the string `MAYAN_` to the name of the configuration
a configuration option, prepend the string ``MAYAN_`` to the name of the configuration
option. For example, to increase the number of documents displayed per search results
page (from a default of 40) to 50 documents, set the environment variable
MAYAN_COMMON_PAGINATE_BY to 50 with::
``MAYAN_COMMON_PAGINATE_BY`` to 50 with::
$ export MAYAN_COMMON_PAGINATE_BY=50
and restart Mayan EDMS. A list of the configuration options can be found in the
`Setup` menu, under `Settings`.
:menuselection:`Setup --> Settings` menu.
Math filters
------------
^^^^^^^^^^^^
The django-mathfilters (https://pypi.python.org/pypi/django-mathfilters) package
has been included to provide proper math filters in the indexes. An example of
this is indexing documents by quarter::
@@ -44,39 +50,46 @@ this is indexing documents by quarter::
Expand searchable objects
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
Previously, only documents and later on document pages were searchable. This release
add support for searching for tags, metadata types and cabinets. This search support
is available via the dynamic search API.
Management command to reset locks
---------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
During testing or development error occur and locks can remain behind, blocking
execution of a process or task until they expire. To help resolve this a
management command has been added called `purgelocks` that will delete all locks
in the system.
Index by workflow state
-----------------------
^^^^^^^^^^^^^^^^^^^^^^^
Support was added to update the a document indexes from workflow state changes.
To make workflow referencing easier from the index template, a new fields was
added to the workflow model called internal_name. For example, for a workflow
called `Publishing Workflow` with an internal name of `publishing_workflow`,
called "Publishing Workflow" with an internal name of ``publishing_workflow``,
use the following string to reference the current state in an index::
{{ document.workflow.publishing_workflow.get_current_state }}
Task manager
------------
^^^^^^^^^^^^
A new app to monitor the distribution and consumption of background task has been
added. This app is call `Task manager` and can be found in the `Tools` menu.
added. This app is call "Task manager" and can be found in the "Tools" menu.
Use this new tool to diagnose your background task workers or to determine when
to scale up the number of workers.
Other Changes
-------------
^^^^^^^^^^^^^
- Improve render of documents with no pages.
- Fix repeated permission list API URL. GitLab issue #389.
- Fix role creation API endpoint not returning id. GitLab issue #390.
@@ -84,19 +97,22 @@ Other Changes
- Add hardware requirements. GitHub issue #247.
- Fix URL query string encoding for the document page navigation views. GitLab
issue #383.
- Truncate views titles via the APPEARANCE_MAXIMUM_TITLE_LENGTH setting.
- Truncate views titles via the ``APPEARANCE_MAXIMUM_TITLE_LENGTH`` setting.
GitLab issue #217.
- Add link to show a document's OCR errors. GitLab issue #291.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -104,8 +120,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -119,8 +136,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -134,23 +152,24 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitHub issue #247 <https://github.com/mayan-edms/mayan-edms/issues/247>`_ Hardware requirements
* `GitLab issue #132 <https://gitlab.com/mayan-edms/mayan-edms/issues/132>`_ Task queue viewer
* `GitLab issue #217 <https://gitlab.com/mayan-edms/mayan-edms/issues/217>`_ [Documents] Truncate document label for avoid double lines in mobile or reduce font
* `GitLab issue #221 <https://gitlab.com/mayan-edms/mayan-edms/issues/221>`_ Add flush lock management command
* `GitLab issue #291 <https://gitlab.com/mayan-edms/mayan-edms/issues/291>`_ Link to OCR error log from document OCR tab
* `GitLab issue #344 <https://gitlab.com/mayan-edms/mayan-edms/issues/344>`_ Add support for searching folders, tags, metadata.
* `GitLab issue #383 <https://gitlab.com/mayan-edms/mayan-edms/issues/383>`_ Page not found when deployed to sub-uri
* `GitLab issue #387 <https://gitlab.com/mayan-edms/mayan-edms/issues/387>`_ Document Scanning not Functioning on rotated landscape PDF's
* `GitLab issue #389 <https://gitlab.com/mayan-edms/mayan-edms/issues/389>`_ How can we map permissions with a particular role using REST API?
* `GitLab issue #390 <https://gitlab.com/mayan-edms/mayan-edms/issues/390>`_ Id is not getting in response
* `GitLab issue #391 <https://gitlab.com/mayan-edms/mayan-edms/issues/391>`_ "Rebuild indexes" does not work in Mayan EDMS 2.3
Bugs fixed or issues closed
---------------------------
* :github-issue:`247` Hardware requirements
* :gitlab-issue:`132` Task queue viewer
* :gitlab-issue:`217` [Documents] Truncate document label for avoid double lines in mobile or reduce font
* :gitlab-issue:`221` Add flush lock management command
* :gitlab-issue:`291` Link to OCR error log from document OCR tab
* :gitlab-issue:`344` Add support for searching folders, tags, metadata.
* :gitlab-issue:`383` Page not found when deployed to sub-uri
* :gitlab-issue:`387` Document Scanning not Functioning on rotated landscape PDF's
* :gitlab-issue:`389` How can we map permissions with a particular role using REST API?
* :gitlab-issue:`390` Id is not getting in response
* :gitlab-issue:`391` "Rebuild indexes" does not work in Mayan EDMS 2.3
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

31
docs/releases/2.5.1.rst
View File

@@ -1,24 +1,26 @@
===============================
Mayan EDMS v2.5.1 release notes
===============================
Version 2.5.1
=============
Released: July 07, 2017
What's new
==========
Changes
-------
This version is identical to version 2.5. It was released to workaround some
issues with the recent migration of PyPI (https://mail.python.org/pipermail/distutils-sig/2017-June/030766.html)
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -26,8 +28,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -41,8 +44,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -56,14 +60,15 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #378 <https://gitlab.com/mayan-edms/mayan-edms/issues/378>`_ Add metadata widget changes from @Macrobb
* `GitLab issue #379 <https://gitlab.com/mayan-edms/mayan-edms/issues/379>`_ Add new document version list view permission.
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`378` Add metadata widget changes from @Macrobb
* :gitlab-issue:`379` Add new document version list view permission.
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

27
docs/releases/2.5.2.rst
View File

@@ -1,14 +1,14 @@
===============================
Mayan EDMS v2.5.2 release notes
===============================
Version 2.5.2
=============
Released: July 08, 2017
What's new
==========
Changes
-------
Improve duplicate document scan
-------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Previously the way document creation code was enclosed in a single database
transactions. This cause the duplicate scan at upload code to received a
document reference to uncommitted database data. The single database
@@ -18,13 +18,15 @@ recevies saved and committed data.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -32,8 +34,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -47,8 +50,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -62,12 +66,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

107
docs/releases/2.5.rst
View File

@@ -1,26 +1,30 @@
=============================
Mayan EDMS v2.5 release notes
=============================
Version 2.5
===========
Released: July 07, 2017
What's new
==========
Changes
-------
OCR text download
-----------------
^^^^^^^^^^^^^^^^^
A link and view were added to download the entire OCR text of a document as a
separate file. The link can be found under the "Actions" dropdown when the
"OCR" tab of a document is selected.
SANE document source
--------------------
^^^^^^^^^^^^^^^^^^^^
A validation error was being raised when the resolution field of the SANE
document source was left blank. This issue has been fixed and works as expected
now.
Mailing profiles
----------------
^^^^^^^^^^^^^^^^
Previously, the way documents were emailed was controlled by configuration
settings that only system administrator could change as the OS level. It is
now possible to create mailing profiles from within the user interface. This
@@ -36,15 +40,19 @@ which could be taxing email quota limits or triggering spam filters. For
more information on the multi-tenant plugin visit the Mayan app store at:
http://www.mayan-edms.com/store/
New transformation
------------------
^^^^^^^^^^^^^^^^^^
A lineart transformation was added to reduce the amount of colors in a
document's image to just 2. This is useful to increase the OCR accuracy on
some kind of documents whose color or layout may confuse the OCR engine
and lower the accuracy of the text recognition.
UI reorganization
-----------------
^^^^^^^^^^^^^^^^^
The main menu was been reorganization for clarity of function. The "About" menu
has been renamed to "System" to signify that the items in this menu relate
to system configuration topics. The "Tools" and "Setup" sub-menus, were moved
@@ -53,22 +61,28 @@ renamed to "User". Additionally, the "User" menu is now part of the main menu
instead of floating right on the layout. This change along with others
improve the usability on small devices like tablets and smartphones.
PDF compatibility updates
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
Support for non-compliant, "broken", and PDFs encrypted with no passwords has
been added. Previously no effort was made to process the images for these
files. The code for detecting the number of pages in a PDF has also been
improved to retry several methods when failing on non-compliant PDF documents.
Office documents compatibility updates
--------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Improvements to the Libre Office conversion code were added, including a
workaround for Libre Office bug #37531 (https://bugs.documentfoundation.org/show_bug.cgi?id=37531)
which sometimes manifested when uploading multiple office documents
sequentially.
Metadata setup UI improvements
------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A new widget to define the document type to metadata type relationship has been
added. The new widget provides a method to switch between required metadata
and optional metadata for a document type. This new method is not only faster
@@ -79,8 +93,10 @@ type view but also from the metadata type view eliminating travel between these
two views when creating new metadata types and assigning them to document
types.
Duplicated document scanning
----------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Support to scan and list duplicated document scanning was added in the form of
a new document list link under the "Documents" main menu. Every time a document
is uploaded, a document scan will be triggered to determine if the new document
@@ -94,27 +110,31 @@ addition of being able to search documents by their checksum. This was done by
indexing the checksum database field and by adding the checksum as a search
field in the advanced document search view and via the API.
Login session control
---------------------
^^^^^^^^^^^^^^^^^^^^^
Support was added to control the length of time a log in session lasts. First
from the user interface side of things a "Remember me" checkbox was added to
the log in form that will cause the session to persist after the browser is
closed. If this checkbox is left blank the session will be destroyed when the
browser closes and the user will need to log in again when accessing any of the
URLs. The second part of this feature is for administrators. The configuration
setting AUTHENTICATION_MAXIMUM_SESSION_LENGTH was added to control the maximum
time a logged in session will persist when users click the "Remember me"
setting ``AUTHENTICATION_MAXIMUM_SESSION_LENGTH`` was added to control the
maximum time a logged in session will persist when users click the "Remember me"
checkbox. The default of this setting is 30 days.
Document image cache disabling
------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It is now possible to disable the document page image caching. The document
image cache works on two level and hence two setting options were added.
The first is the DOCUMENTS_DISABLE_BASE_IMAGE_CACHE option which disables the
The first is the ``DOCUMENTS_DISABLE_BASE_IMAGE_CACHE`` option which disables the
first layer of caching, the generation of a master image file for each document
page. This means that subsequent request for a page's image will trigger the
conversion of the document from its original uploaded file. The second option,
DOCUMENTS_DISABLE_TRANSFORMED_IMAGE_CACHE, disables just the caching of the
``DOCUMENTS_DISABLE_TRANSFORMED_IMAGE_CACHE``, disables just the caching of the
transformed (rotated, resized, zoomed) images of document pages. The settings
can be used together or separately depending on how much disk space saving is
desired. These settings give control over the trade-off between disk space
@@ -122,19 +142,24 @@ savings and higher CPU utilization. These settings are ideal for installations
with a lot of documents, that want to conserve disk space, and have CPU capacity
to spare. Multi-tenant installations can also benefit from these new settings.
Document filter by workflow state
---------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A few versions over, a main menu item was added to list documents by their
workflow and/or their current workflow state. Support for filtering by the
initial workflow state has been added to this feature.
Support for restoring forgotten password
----------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Views and templates were added to enable the typical "Forgotten
password" worflow using a signed token via email.
Other Changes
-------------
^^^^^^^^^^^^^
- Add missing OCR migration.
- Improve error output of the performupgrade command to debug upgrade errors
that could stop an upgrade (missing document files, etc).
@@ -153,14 +178,14 @@ Other Changes
- Make sure lookup selection widgets also trigger the metadata update
checkbox on change.
- Usability improvements on small displays.
- Removal of the CONVERTER_LIBREOFFICE_PATH and CONVERTER_PDFTOPPM_PATH
- Removal of the ``CONVERTER_LIBREOFFICE_PATH`` and ``CONVERTER_PDFTOPPM_PATH``
settings. These setting have been consolidated into
CONVERTER_GRAPHICS_BACKEND_CONFIG.
``CONVERTER_GRAPHICS_BACKEND_CONFIG``.
- Improve the documentation of the document creation API endpoint.
GitHub issue #255. Thanks to @lcerliani opening the issue.
- Libre Office conversion improvements. Give every libreoffice instance
its own separate $HOME directory. Additionally give every libreoffice
its own UserInstallation file in the $HOME directory. Works around
its own separate ``$HOME`` directory. Additionally give every libreoffice
its own UserInstallation file in the ``$HOME`` directory. Works around
Libre Office issue: https://bugs.documentfoundation.org/show_bug.cgi?id=37531
Solves or affects GitLab issues #393 #258 #198 #175
- The trashed document deletion action is now a background task. This
@@ -181,15 +206,18 @@ Other Changes
- Unicode handling improvements.
- Update required versions of Pillow and django-suit.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -197,8 +225,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -212,8 +241,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -227,17 +257,18 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitHub issue #255 <https://github.com/mayan-edms/mayan-edms/issues/255>`_ Uploading a local file via api
* `GitLab issue #215 <https://gitlab.com/mayan-edms/mayan-edms/issues/215>`_ Download text contents
* `GitLab issue #286 <https://gitlab.com/mayan-edms/mayan-edms/issues/286>`_ User configurable mailer
* `GitLab issue #337 <https://gitlab.com/mayan-edms/mayan-edms/issues/337>`_ Better way to switch Optional to Required Metadata
* `GitLab issue #373 <https://gitlab.com/mayan-edms/mayan-edms/issues/373>`_ (feature request) Allow selecting document types for metadata
Bugs fixed or issues closed
---------------------------
* :github-issue:`255` Uploading a local file via api
* :gitlab-issue:`215` Download text contents
* :gitlab-issue:`286` User configurable mailer
* :gitlab-issue:`337` Better way to switch Optional to Required Metadata
* :gitlab-issue:`373` (feature request) Allow selecting document types for metadata
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

28
docs/releases/2.6.1.rst
View File

@@ -1,25 +1,25 @@
=============================
Mayan EDMS v2.6 release notes
=============================
Version 2.6
===========
Released: July 18, 2017
What's new
==========
Changes
-------
Other Changes
-------------
- Fix issue when editing or removing metadata from multiple documents.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -27,8 +27,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -42,8 +43,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -57,13 +59,15 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

30
docs/releases/2.6.2.rst
View File

@@ -1,16 +1,13 @@
===============================
Mayan EDMS v2.6.2 release notes
===============================
Version 2.6.2
=============
Released: July 22, 2017
What's new
==========
This is a bug fix release and users are encouraged to upgrade.
Other Changes
-------------
Changes
-------
- Fix deprecation warning to prepare upgrade to Django 1.11 and 2.0.
- Fix zoom feature in document page view.
- Add support to run tests against a MySQL or Postgres container.
@@ -20,15 +17,18 @@ Other Changes
- Allow total page number instrospection of encrypted PDF with non ASCII
user properties. GitLab issue #411.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -36,8 +36,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -51,8 +52,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -66,13 +68,15 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

35
docs/releases/2.6.3.rst
View File

@@ -1,16 +1,13 @@
===============================
Mayan EDMS v2.6.3 release notes
===============================
Version 2.6.3
=============
Released: July 25, 2017
What's new
==========
This is a bug fix release and users are encouraged to upgrade.
Changes
-------
- Add makefile target to launch a PostgreSQL container.
- Use resolve_url instead of redirect to resolve the post login URL.
- Make the intialsetup and performupgrade management tasks work
@@ -26,15 +23,18 @@ Changes
#149 #200.
- Add fade in animation to document images.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -42,8 +42,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -57,8 +58,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -72,16 +74,17 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #149 <https://gitlab.com/mayan-edms/mayan-edms/issues/149>`_ Autogenerate setup.py
* `GitLab issue #200 <https://gitlab.com/mayan-edms/mayan-edms/issues/200>`_ dependencies in setup.py not up to date with requirements
* `GitLab issue #402 <https://gitlab.com/mayan-edms/mayan-edms/issues/402>`_ Make permissions and roles searchable.
* `GitLab issue #413 <https://gitlab.com/mayan-edms/mayan-edms/issues/413>`_ source.models.Source.handle_upload does not support tag_ids but upload_document does
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`149` Autogenerate setup.py
* :gitlab-issue:`200` dependencies in setup.py not up to date with requirements
* :gitlab-issue:`402` Make permissions and roles searchable.
* :gitlab-issue:`413` source.models.Source.handle_upload does not support tag_ids but upload_document does
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

26
docs/releases/2.6.4.rst
View File

@@ -1,27 +1,28 @@
===============================
Mayan EDMS v2.6.4 release notes
===============================
Version 2.6.4
=============
Released: July 25, 2017
What's new
==========
This is a bug fix release and users are encouraged to upgrade.
Changes
-------
- Add missing replacements of reverse to resolve_url.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -29,8 +30,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -44,8 +46,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -59,12 +62,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

69
docs/releases/2.6.rst
View File

@@ -1,20 +1,22 @@
=============================
Mayan EDMS v2.6 release notes
=============================
Version 2.6
===========
Released: July 18, 2017
What's new
==========
Changes
-------
Sending documents to multiple recipients
----------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Support was added to send a document as an attachment, or a link to a document
to multiple email recipients. To use this feature enter a comman separated
list of email recipients in the "Email address" field.
Visual changes
--------------
^^^^^^^^^^^^^^
Several patches to change and improve the user interface landed on this release.
The first, by Macrobb Simpson @Macrobb, makes the content area width, match
window area. This means that on almost all device screen sizes the content area
@@ -28,21 +30,27 @@ requires two axis navigation on small screens. The height of the dashboard
items is now adjusted via javascript to ensure correct layout regardless of
screen size of message length when translated.
Search
------
^^^^^^
This release adds users and groups to the list of objects that are searchable
via the API. The current list of searchable objects is: metadata types,
users, groups, tags, documents, document pages, and cabinets.
Logging
-------
^^^^^^^
The logging configuration was improved to create a log for critical errors
when running on production mode. The default location for this log file is:
/mayan/error.log. This path can be changed with the COMMON_PRODUCTION_ERROR_LOG_PATH
setting. This log file will capture application errors and request exceptions.
Cabinets
--------
^^^^^^^^
The access control for cabinets has been fixed in some regards and improved in
others. The permission to add and remove documents can now be applied to
individual root cabinets instead of globally for a role. Also, the permission
@@ -51,30 +59,37 @@ or document type. In other words, to add a document to a cabinet, the user's
role must have the permission to add documents to cabinet, for the cabinet
to recieve the document and for the document about to be added.
New permission
--------------
^^^^^^^^^^^^^^
The patch to add a permission to view a document's version list was backported
from the development branch to make it accesible now. Like cabinets, the tag
access control now works on two levels. Now to attach a tag to a document,
the permission to attach tags must be granted to the tag to attach and to the
document that will receive the tag.
ACL changes
-----------
^^^^^^^^^^^
The document type permissions namespace was renamed from "Document setup" to
"Document types" for clarity. Along with that change, support was added
for granting the document type edit, document type delete, and document type view
permissions to individual document type instances instead of just globally.
Testing
-------
^^^^^^^
The documents app view tests now test for view access and not just permission.
Testing against access is more robust and also tests for permissions
implicitly.
Other Changes
-------------
^^^^^^^^^^^^^
- Fix HTML mark up in window title. GitLab #397.
- Sort setting by namespace label and by global name second.
- Sort indexes by label.
@@ -82,15 +97,17 @@ Other Changes
- Improve code to unbind menu entries.
- Increase the size of the mailing profile label field to 128 characters.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -98,8 +115,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -113,8 +131,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -128,16 +147,18 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #378 <https://gitlab.com/mayan-edms/mayan-edms/issues/378>`_ Add metadata widget changes from @Macrobb
* `GitLab issue #396 <https://gitlab.com/mayan-edms/mayan-edms/issues/396>`_ Add support for emailing documents to a recipient list.
* `GitLab issue #397 <https://gitlab.com/mayan-edms/mayan-edms/issues/397>`_ Title on Index Page is Broken
* `GitLab issue #400 <https://gitlab.com/mayan-edms/mayan-edms/issues/400>`_ Django REST framework's BasicAuthentication doesn't work with Oauth2_proxy
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`378` Add metadata widget changes from @Macrobb
* :gitlab-issue:`396` Add support for emailing documents to a recipient list.
* :gitlab-issue:`397` Title on Index Page is Broken
* :gitlab-issue:`400` Django REST framework's BasicAuthentication doesn't work with Oauth2_proxy
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

42
docs/releases/2.7.1.rst
View File

@@ -1,22 +1,24 @@
===============================
Mayan EDMS v2.7.1 release notes
===============================
Version 2.7.1
=============
Released: September 3, 2017
What's new
==========
Changes
-------
Unicode metadata when uploading a document
------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
An issue with Django's unquote_plus caused documents being uploaded with an
unicode, no English character in an initial metadata value field to fail.
The unquote_plus usage was remove in favor of a dedicate URL parsing library
called furl. GitLab issue #423. Thanks to Gustavo Teixeira (@gsteixei) for the
find.
Silent errors during initialization
-----------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When Python raises an ImportError exception, it is not possible to determine
the cause of the error. The local.py import code was updated to interpret the
text of the ImportError exception and ignore it only if the local.py was
@@ -24,28 +26,32 @@ missing, which is the case during the initialization commands execute after
the initial installation. Any error in the local.py file will now cause Mayan
to exit. Thanks to MacRobb Simpson for the report and solution.
String usage in the local.py file
---------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Python 2.7 uses byte strings by default. Byte strings cannot be used in
conjunction with unicode strings. A missing import was causing strings in
the local.py file to be interpreted as byte string while the rest of Mayan
uses unicode strings. Using non English special characters in a string located
in the local.py file would have cause a Unicode errors. For new installations
from Mayan version 2.7.1 onwards, the line
`from __future__ import absolute_imports, unicode_literals` is included when
``from __future__ import absolute_imports, unicode_literals`` is included when
generating the local.py for the first time. For existing installations,
adding this line at the top is all that's needed. GitLab issue #424. Thanks to
Gustavo Teixeira (@gsteixei) for the find and researching the cause.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -53,8 +59,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -68,8 +75,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -83,15 +91,15 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #423 <https://gitlab.com/mayan-edms/mayan-edms/issues/423>`_ Metadata can't handle non ascii chars on upload
* `GitLab issue #424 <https://gitlab.com/mayan-edms/mayan-edms/issues/424>`_ DjangoUnicodeDecodeError on document proprieties due document language field
---------------------------
* :gitlab-issue:`423` Metadata can't handle non ascii chars on upload
* :gitlab-issue:`424` DjangoUnicodeDecodeError on document proprieties due document language field
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

52
docs/releases/2.7.2.rst
View File

@@ -1,21 +1,23 @@
===============================
Mayan EDMS v2.7.2 release notes
===============================
Version 2.7.2
=============
Released: September 06, 2017
What's new
==========
Changes
-------
Fixes to the new mailer creation view
-------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Some last minute changes to the dynamic form creation code added to support
workflow state actions broke the creation of new mailer profiles. This is fixed
now and a test was added to avoid future regressions. GitLab issue #431.
Thanks to Robert Schöftner (@robert.schoeftner) for the report and the solution.
Event consolidation
-------------------
^^^^^^^^^^^^^^^^^^^
Several events were created to audit the creation of new documents. These events
caused some confusion and were improved. When creating a new document the two
'document properties edited' events were removed as this is an internal process
@@ -24,32 +26,41 @@ submits the file to create the document. Now instead of 'System' the actual
username of the user that uploaded the document will appear in the events log.
GitLab issue #433. Thanks to Jesaja Everling (@jeverling) for the report.
Cabinet list sorting
--------------------
^^^^^^^^^^^^^^^^^^^^
The root cabinet list is now displayed alphabetically sorted. The list of
cabinets to which a document belongs to is now displayed sorted too. Thanks
to Thomas Plotkowiak for the request.
Visual cue for the document cabinet list
----------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In the document list item view, a simple visual cue in the form of italized
text was added to the document cabinet list. GitLab issue #435. Thanks to LeVon
Smoker for the request.
Easier testing of production deployments
----------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The testing library mock is now installed by default, making it easier to run
the entire test suit on deployed instances.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -57,8 +68,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -72,8 +84,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -87,15 +100,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #431 <https://gitlab.com/mayan-edms/mayan-edms/issues/431>`_ can't create new mailer
* `GitLab issue #433 <https://gitlab.com/mayan-edms/mayan-edms/issues/433>`_ Events are not created correctly for document upload
* `GitLab issue #435 <https://gitlab.com/mayan-edms/mayan-edms/issues/435>`_ Add visual cue to differentiate the Cabinet list on a document's preview card.
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`431` can't create new mailer
* :gitlab-issue:`433` Events are not created correctly for document upload
* :gitlab-issue:`435` Add visual cue to differentiate the Cabinet list on a document's preview card.
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

31
docs/releases/2.7.3.rst
View File

@@ -1,11 +1,10 @@
===============================
Mayan EDMS v2.7.3 release notes
===============================
Version 2.7.3
=============
Released: September 11, 2017
What's new
==========
Changes
-------
- Fix task manager queue list view. Thanks to LeVon Smoker for
the report.
@@ -14,15 +13,18 @@ What's new
Nick Douma (LordGaav) for the report and diagnostic information. GitLab
issue #436.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -30,8 +32,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -45,8 +48,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -60,15 +64,16 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #431 <https://gitlab.com/mayan-edms/mayan-edms/issues/431>`_ can't create new mailer
* `GitLab issue #436 <https://gitlab.com/mayan-edms/mayan-edms/issues/436>`_ New document source menu does not contain source_ids
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`431` can't create new mailer
* :gitlab-issue:`436` New document source menu does not contain source_ids
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

95
docs/releases/2.7.rst
View File

@@ -1,14 +1,14 @@
=============================
Mayan EDMS v2.7 release notes
=============================
Version 2.7
===========
Released: August 30, 2017
What's new
==========
Changes
-------
Beta Python 3 support
---------------------
^^^^^^^^^^^^^^^^^^^^^
Preliminary support for Python 3 has landed in this version. More testing
is still needed but for the most part seems to be usable. This is just
initial support and not meant for production. Please submit any issue with
@@ -16,14 +16,16 @@ Python 3 to help improve the support for it.
PDF introspection improvements
------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Some PDF files encode their page rotation information using indirect values
instead of actually storing the rotation value as an integer. Support these
types of PDF files was added.
3rd party apps
--------------
^^^^^^^^^^^^^^
Support was added to allow 3rd party app adding data columns to existing
models to specify the order in which such new columns will appear. Support
was also added to allow any app to remove existing main menus. App can now in
@@ -33,7 +35,8 @@ create multiple dashboards.
Converter customization improvements
------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For users wanting more control over the document image conversion process,
support was added to change the internal format used for image conversion.
By default JPG used but via the `pdftoppm_format` and `pillow_format` entries
@@ -45,7 +48,8 @@ value is `pdftoppm_dpi`.
Workflow refactor
-----------------
^^^^^^^^^^^^^^^^^
This version includes a preview release of the workflow refactor that includes
three new features: transition triggers, state actions, and graphical previews.
The transition triggers allow setting document events as triggers to perform
@@ -64,7 +68,8 @@ debugging workflows.
OCR refactor
------------
^^^^^^^^^^^^
As part of the plan to add OCR zone and barcode support the first set of
changes was included in this version. These initial changes bring the OCR
app up to standard with the rest of the system and splits the OCR app into two
@@ -78,7 +83,8 @@ by OCR.
Document parsing
----------------
^^^^^^^^^^^^^^^^
Historically Mayan has had two methods to extract text from PDF files. First
it will try the program called `pdftotext` and failing that will try the
PDFMiner Python library. The official PDFMiner library is unmaintained and
@@ -92,7 +98,8 @@ extraction strategy.
Document version UI
-------------------
^^^^^^^^^^^^^^^^^^^
The list of versions of a document was updated to use the new item list
view templated added in version 2.6 for document lists. Along with this update
preview support was added for individual document version. It is also possible
@@ -102,7 +109,8 @@ example the difference in a document's versions.
Events system
-------------
^^^^^^^^^^^^^
The events system has been updated to provide more information and improve
navigation. The `Actor` field will now display `System` when an event was
performed by the system instead of displaying the document name. The
@@ -136,28 +144,31 @@ to trigger a workflow transition. The current list:
Metadata on document type change
--------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changing document types will no longer delete all metadata from the document.
Any existing metadata whose type matches the metadata in the new type will be
preserved.
Permission rebalance
--------------------
^^^^^^^^^^^^^^^^^^^^
In order to attach or remove a tag to a document, the tag view permissions
was needed. This has been update to required the tag attach and remove
permissions respectively.
Other Changes
-------------
- Add workaround for PDF with IndirectObject as the
^^^^^^^^^^^^^
- Add workaround for PDF with ``IndirectObject`` as the
rotation value. GitHub #261.
- Add ACL list link with icon and use it for the document facet menu.
- Fix mailing app permissions labels.
- Add ACLs link and ACLs permissions to the mailer profile model.
- Improve mailer URL regex.
- Add ordering support to the SourceColumn class. GitLab issue #417.
- Add ordering support to the ``SourceColumn`` class. GitLab issue #417.
- Shows the cabinets in the document list. GitLab #417 @corneliusludmann
- Update the index information colums to show the
total number of documents and nodes contained in a level.
@@ -165,8 +176,8 @@ Other Changes
GitHub issue #250.
- Skip UUID migration on Oracle backends. GitHub issue #251.
- Allow changing the output format, DPI of the pdftoppm command, and
the output format of the converter via the CONVERTER_GRAPHICS_BACKEND_CONFIG
setting sub options: pdftoppm_dpi: 300, pdftoppm_format: jpeg, pillow_format: jpeg
the output format of the converter via the ``CONVERTER_GRAPHICS_BACKEND_CONFIG``
setting sub options: ``pdftoppm_dpi: 300, pdftoppm_format: jpeg, pillow_format: jpeg``
GitHub issues #256 #257 GitLab issue #416.
- Add support for workflow triggers.
- Add support for workflow actions. Includes actions to attach and remove tags,
@@ -206,18 +217,21 @@ Other Changes
- Avoid Maximum recursion depth exceeded exception on index document
list view.
Removals
--------
- Folders app.
- The view to submit all document for OCR. The view to submit documents by type
substitutes this once.
- The PDFMiner parser.
- The ``PDFMiner`` parser.
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -225,8 +239,9 @@ Type in the console::
the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -240,8 +255,9 @@ Next upgrade/add the new requirements::
$ pip install --upgrade -r requirements.txt
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -255,25 +271,26 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* `GitHub issue #250 <https://github.com/mayan-edms/mayan-edms/issues/250>`_ migrate fails on documents.0025_auto_20150718_0742
* `GitHub issue #251 <https://github.com/mayan-edms/mayan-edms/issues/251>`_ migrate fails on documents.0032_auto_20160315_0537
* `GitHub issue #256 <https://github.com/mayan-edms/mayan-edms/issues/256>`_ Make it possible to adjust values in apps\converter\literals.py from Settings
* `GitHub issue #257 <https://github.com/mayan-edms/mayan-edms/issues/257>`_ Use the DEFAULT_FILE_FORMAT from literals.py in python.py
* `GitHub issue #261 <https://github.com/mayan-edms/mayan-edms/issues/261>`_ fix_orientation method causes document add to crash
* `GitHub issue #263 <https://github.com/mayan-edms/mayan-edms/issues/263>`_ Typo in mayan/apps/ocr/migrations/0004_documenttypesettings.py
* `GitLab issue #172 <https://gitlab.com/mayan-edms/mayan-edms/issues/172>`_ Metadata default value ignored when changing document type
* `GitLab issue #329 <https://gitlab.com/mayan-edms/mayan-edms/issues/329>`_ Move code to Python 3
* `GitLab issue #415 <https://gitlab.com/mayan-edms/mayan-edms/issues/415>`_ Wrong filename when downloading document version
* `GitLab issue #416 <https://gitlab.com/mayan-edms/mayan-edms/issues/416>`_ DPI value for OCR not taken from document metadata
* `GitLab issue #417 <https://gitlab.com/mayan-edms/mayan-edms/issues/417>`_ Display document cabinets in documents list
* `GitLab issue #421 <https://gitlab.com/mayan-edms/mayan-edms/issues/421>`_ Metadata lost when changing document type
* :github-issue:`250` migrate fails on documents.0025_auto_20150718_0742
* :github-issue:`251` migrate fails on documents.0032_auto_20160315_0537
* :github-issue:`256` Make it possible to adjust values in apps\converter\literals.py from Settings
* :github-issue:`257` Use the DEFAULT_FILE_FORMAT from literals.py in python.py
* :github-issue:`261` fix_orientation method causes document add to crash
* :github-issue:`263` Typo in mayan/apps/ocr/migrations/0004_documenttypesettings.py
* :gitlab-issue:`172` Metadata default value ignored when changing document type
* :gitlab-issue:`329` Move code to Python 3
* :gitlab-issue:`415` Wrong filename when downloading document version
* :gitlab-issue:`416` DPI value for OCR not taken from document metadata
* :gitlab-issue:`417` Display document cabinets in documents list
* :gitlab-issue:`421` Metadata lost when changing document type
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

29
docs/releases/3.0.1.rst
View File

@@ -1,27 +1,29 @@
===============================
Mayan EDMS v3.0.1 release notes
===============================
Version 3.0.1
=============
Released: July 08, 2018
What's new
==========
Changes
-------
- Pin javascript libraries to specific versions to avoid using
potentianlly broken updates automatically. GitLab issue #486.
- French and Polish language translation updates.
- Merge request #25. Thanks to Daniel Albert @esclear
for the patch.
Removals
--------
- None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -31,7 +33,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -47,7 +49,7 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -61,13 +63,14 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #486 <https://gitlab.com/mayan-edms/mayan-edms/issues/486>`_ Docker Verison 3.0 not working
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`486` Docker Verison 3.0 not working
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

57
docs/releases/3.0.2.rst
View File

@@ -1,15 +1,17 @@
===============================
Mayan EDMS v3.0.2 release notes
===============================
Version 3.0.2
=============
Released: August 16, 2018
What's new
==========
Changes
-------
This bug fix release also includes a few tweaks to improve user experience.
Docker install script
---------------------
^^^^^^^^^^^^^^^^^^^^^
- Default to verbose.
- Increase startup timer from 5 to 10 seconds to give more time to users to
examine the settings of the installation to be performed.
@@ -18,8 +20,10 @@ Docker install script
- Docker install script: Detect if Docker installed and provide help
text if not.
Documentation
-------------
^^^^^^^^^^^^^
Add deployment step that configures Redis to discard unused task data when
it runs out of memory. Redis is only used for volatile data therefore
configuring it to discard data doesn't affect functionality but increases
@@ -33,12 +37,15 @@ documentation. The pending work list has been divided into a pending and a
planned feature list and moved to the new Wiki at wiki.mayan-edms.com
Builds
------
^^^^^^
Limit the number of branches that trigger the full test suit. Makes better use
of the amount of free continous integration available in GitLab.
Program code
------------
^^^^^^^^^^^^
- Index app: Add natural key support to the Index model.
- Mailer app: Add natural key support to the mailer app.
- Cabinets: Redirect to the cabinet list view after creating a new cabinet.
@@ -46,7 +53,7 @@ Program code
- Converter app: Add error checking to the crop transformation arguments.
Thanks to Jordan Wages (@wagesj45) for the report and investigation on the issue.
Closes GitLab issue #490
- Common app: Fix post login redirection to honor the ?next= URL query string
- Common app: Fix post login redirection to honor the ``?next=`` URL query string
argument. Thanks go to K.C. Wong (@dvusboy1). Closes GitLab
issue #489.
- Sources app: Update dropzone.js' timeout from 30 seconds to 120 to allow
@@ -64,8 +71,9 @@ Program code
- Documents app: Hide the title link of documents in the trash.
- Workflow app: Define a redirection after workflow actions are edited.
Security
--------
^^^^^^^^
- Appearance app: avoid setting window.location directly to avoid exploit
of cross site scripting. Thanks to Lokesh (@lokesh1095) for the report
and solution. Closes GitLab issue #494.
@@ -73,16 +81,18 @@ Security
cross site scripting. Thanks to Lokesh (@lokesh1095) for the report
and proposed solutions. Closes GitLab issue #495.
Removals
--------
- None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -92,7 +102,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -108,7 +118,7 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -122,17 +132,18 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #489 <https://gitlab.com/mayan-edms/mayan-edms/issues/489>`_ "next" parameter is not honored after login
* `GitLab issue #490 <https://gitlab.com/mayan-edms/mayan-edms/issues/490>`_ Crop Transformation seems to not convert input to numeric values
* `GitLab issue #491 <https://gitlab.com/mayan-edms/mayan-edms/issues/491>`_ "Warning Your database backend is set to use SQLite[...]" with docker compose
* `GitLab issue #494 <https://gitlab.com/mayan-edms/mayan-edms/issues/494>`_ DOM based Cross Site Scripting
* `GitLab issue #495 <https://gitlab.com/mayan-edms/mayan-edms/issues/495>`_ Persistent Cross Site Scripting
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`489` "next" parameter is not honored after login
* :gitlab-issue:`490` Crop Transformation seems to not convert input to numeric values
* :gitlab-issue:`491` "Warning Your database backend is set to use SQLite[...]" with docker compose
* :gitlab-issue:`494` DOM based Cross Site Scripting
* :gitlab-issue:`495` Persistent Cross Site Scripting
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

35
docs/releases/3.0.3.rst
View File

@@ -1,33 +1,37 @@
===============================
Mayan EDMS v3.0.3 release notes
===============================
Versin 3.0.3
============
Released: August 17, 2018
What's new
==========
Changes
-------
Program code
------------
^^^^^^^^^^^^
- Tags app: Add explicit post action redirect for the tag attach and
tag remove actions when working on a single document.
Security
--------
^^^^^^^^
- Tags app: Add explicit casting of escaped tag labels to prevent exploit
of cross site scripting. Thanks to Lokesh (@lokesh1095) for
the report and proposed solutions. Closes GitLab issue #496.
Removals
--------
- None
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -37,7 +41,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -53,7 +57,7 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -67,13 +71,14 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #496 <https://gitlab.com/mayan-edms/mayan-edms/issues/496>`_ Persistent Cross Site Scripting
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`496` Persistent Cross Site Scripting
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

213
docs/releases/3.0.rst
View File

@@ -1,14 +1,14 @@
=============================
Mayan EDMS v3.0 release notes
=============================
Version 3.0
===========
Released: June 29, 2018
What's new
==========
Changes
-------
Turning Mayan EDMS into a single page app
-----------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Historically, Mayan EDMS has steered away from adding too much Javascript
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.
@@ -33,7 +33,8 @@ improvements are now possible.
Upgrading to Django 1.11
------------------------
^^^^^^^^^^^^^^^^^^^^^^^^
The move to Django 1.11 proved to be a real challenge. Even though
Django 1.11 is a minor release, it breaks compatibility and interfaces
in several key areas. Among these were templates and form widgets.
@@ -49,7 +50,8 @@ warning were fixed in preparation for an eventual upgrade to Django 2.0.
Notification improvements
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
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
@@ -57,7 +59,8 @@ main menu bar.
Dependencies upgrades
---------------------
^^^^^^^^^^^^^^^^^^^^^
Most of the requirements, dependencies and libraries were upgraded to
their latest release.
@@ -81,7 +84,8 @@ their latest release.
Search syntax
-------------
^^^^^^^^^^^^^
Searching without using a specialized search database is difficult.
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
@@ -115,7 +119,8 @@ This will return only documents with the exact phrase “blue car”.
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.
@@ -130,7 +135,8 @@ all practical purposes.
Display resolution settings
---------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
@@ -148,7 +154,7 @@ The settings are now:
Dynamic upload wizard steps
---------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The steps needed to upgrade a document using form-tools' SessionWizard
were hardcoded in the source app. This made it very difficult to add or remove
wizard steps.
@@ -232,7 +238,8 @@ wizard anymore.
New upload step
---------------
^^^^^^^^^^^^^^^
Using the new ``WizardStep`` class a new upload wizard step was added
to assign documents being uploaded to any number of cabinets while
being uploaded. This step was been assigned number 4 in the order of
@@ -240,20 +247,23 @@ step for uploading a file.
Fix carousel item height issues
-------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
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
@@ -261,7 +271,8 @@ itself and MERC-2 documents the way API tests are to be written for Mayan EDMS.
Duplicated documents
--------------------
^^^^^^^^^^^^^^^^^^^^
The duplicated documents system has been improved to also better detect when
the duplicate of a primary document has been move to the trash. In this
instance the duplicate count of the primary document would be zero and will
@@ -271,8 +282,10 @@ If the duplicated document is deleted from the trash the system now will launch
a background clean up task to permanently delete the empty primary document's
duplicate document entry from the database.
Storage
-------
^^^^^^^
It is now possible to pass arguments to the document, document cache and
document signatures storage backends. To pass the arguments, use the new
settings: ``DOCUMENTS_STORAGE_BACKEND_ARGUMENTS``,
@@ -295,24 +308,30 @@ If no path is specified the backend will default to ``mayan/media/document_stora
Finally, to standardize the way app use storage, the ``storages.py`` modules is now used
instead of the ``runtime.py`` module.
User event filtering
--------------------
^^^^^^^^^^^^^^^^^^^^
When viewing the event list, the Actor (user) column is not displayed
as a link. Clicking this link will filter the event list and display
the events performed by that user. The view of event for each user can
also be viewed using a new link added to the user list view in the setup
menu.
Smart checkbox selection
------------------------
^^^^^^^^^^^^^^^^^^^^^^^^
A faster way to select multiple item has been added. Click the checkbox of the first,
hold the Shift key, and then click the checkbox of the last item of the selection.
This will select the first, the last and all items in between. To deselect multiple
items the same procedure is used. This code was donated by the Paperattor
project (www.paperattor.com).
Add JavaScript dependency manager
---------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
An internal utility to install and upgrade the JavaScript dependencies was added.
This depency manager allows for the easier maintenace of the JavaScript libraries
used through the project.
@@ -326,13 +345,17 @@ allows apps to specify their own dependencies. These dependecies are then
downloaded when the project is installed or upgraded. As such they are not
part of the repository and lower the file size of the project.
Workflow changes
----------------
^^^^^^^^^^^^^^^^
Removing a document type from a workflow will now also remove all running
instances of that workflow for documents of the document type just removed.
Adoption of Contributor Assignment Agreements
---------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To facilitate the inclusion of submissions provided by third parties,
the project has adopted the use of individual and entity contributor
assignment agreements. These agreements make clear the process to
@@ -340,8 +363,10 @@ transfer the rights to submissions. With these agreements in place
we now have a documented and legally sound method to accept
submissions that we couldn't before.
SQLite
------
^^^^^^
Starting with version 3.0, a warning message will be shown in the console and
in the user interface when using SQLite as the database engine. When it comes to
Mayan EDMS, SQLite should only be used for development or testing, never for
@@ -350,8 +375,10 @@ SQLite. The results are duplicated documents, frequency database locked errors,
among other issues. Suggested database backends are PostgreSQL and MySQL
(or MariaDB) using a transaction aware storage engine like InnoDB.
Received email processing
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
Parsing email messages is a complex task. To increase compatibility with the
many interpretations of the standards that govern email messaging, Mayan EDMS
now uses Mailgun's flanker library (https://github.com/mailgun/flanker).
@@ -359,8 +386,10 @@ Thanks to flanker, Mayan EDMS now gains new capabilities when it comes to
parsing incoming email. For example, in addition to mail attachments, it is now
possible to process files included in emails as inline content.
Other changes worth mentioning
------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Add Makefile target to check the format of the README.rst file.
- Fix permission filtering when performing document page searching
- base.js was splitted into mayan_app.js, mayan_image.js, and
@@ -488,18 +517,19 @@ Other changes worth mentioning
- Add a new setting option to enable automatic parsing for each new document
type created.
- Add support for HTML bodies to the user mailers.
- Production ALLOWED_HOSTS settings now defaults to a safer
['127.0.0.1', 'localhost', '[::1]']
- Production ``ALLOWED_HOSTS`` settings now defaults to a safer
``['127.0.0.1', 'localhost', '[::1]']``
- Capture menu resolution errors on invalid URLs. Closes GitLab issue #420.
- New environment variables: MAYAN_SECRET_KEY, MAYAN_CELERY_ALWAYS_EAGER,
MAYAN_CELERY_RESULT_BACKEND, MAYAN_BROKER_URL, MAYAN_DATABASE_ENGINE,
MAYAN_DATABASE_CONN_MAX_AGE, MAYAN_DATABASE_NAME, MAYAN_DATABASE_USER,
MAYAN_DATABASE_PASSWORD, MAYAN_DATABASE_HOST, MAYAN_DATABASE_PORT,
MAYAN_DEBUG.
- Stricter defaults. CELERY_ALWAYS_EAGER to False, ALLOWED_HOSTS to
['127.0.0.1', 'localhost', '[::1]'].
- New environment variables: ``MAYAN_SECRET_KEY``,
``MAYAN_CELERY_ALWAYS_EAGER``, ``MAYAN_CELERY_RESULT_BACKEND``,
``MAYAN_BROKER_URL``, ``MAYAN_DATABASE_ENGINE``,
``MAYAN_DATABASE_CONN_MAX_AGE``, ``MAYAN_DATABASE_NAME``,
``MAYAN_DATABASE_USER``, ``MAYAN_DATABASE_PASSWORD``,
``MAYAN_DATABASE_HOST``, ``MAYAN_DATABASE_PORT``, ``MAYAN_DEBUG``.
- Stricter defaults. CELERY_ALWAYS_EAGER to False, ``ALLOWED_HOSTS`` to
``['127.0.0.1', 'localhost', '[::1]']``.
- New initialization command. Creates media/system and populates the
SECRET_KEY and VERSION files.
``SECRET_KEY`` and ``VERSION`` files.
- Sane scanner source paper source now defaults to blank.
- Merge Docker image creation back into the main repository.
- Docker image now uses gunicorn and whitenoise instead of NGINX to server
@@ -507,32 +537,43 @@ Other changes worth mentioning
- All installation artifact are now created and read from the media folder.
- Debian is now the Linux distribution used for the Docker image.
- Most Docker Celery workers are now execute using a lower OS priority number.
- Add COMMON_PRODUCTION_ERROR_LOGGING setting to control the logging of
- Add ``COMMON_PRODUCTION_ERROR_LOGGING`` setting to control the logging of
errors in production. Defaults to False.
- Change the error log file handle class to RotatingFileHandle to avoid an
indefinitely growing log file.
- Disable embedded signature verification during the perform upgrade command.
- Replace the DOCUMENTS_LANGUAGE_CHOICES setting option. Replaced with the
new DOCUMENTS_LANGUAGE_CODES.
- Replace the ``DOCUMENTS_LANGUAGE_CHOICES`` setting option. Replaced with the
new ``DOCUMENTS_LANGUAGE_CODES``.
- Reduce default language code choice from 7800 to the top 100 spoken
languages and related (https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers)
- Fix error when trying to upload a document from and email account with 'from' and 'subject' metadata.
languages and related
(https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers)
- Fix error when trying to upload a document from and email account with
'from' and 'subject' metadata.
- Fix typo on message.header get from 'Suject' to 'Subject'.
- On multi part emails keep the original From and Subject properties for all subsequent parts if the sub parts don't specify them. Fixes issue #481. Thanks to Robert Schöftner @robert.schoeftner for the report and debug information.
- Don't provide a default for the scanner source adf_mode. Some scanners throw an error even when the selection
if supported.
- Add a "Quick Download" action to reduce the number of steps to download a single document. GitLab issue #338.
- Recalculate a document's indexes when attaching or removing a tag from or to it.
- On multi part emails keep the original From and Subject properties for
all subsequent parts if the sub parts don't specify them. Fixes issue
#481. Thanks to Robert Schöftner @robert.schoeftner for the report and
debug information.
- Don't provide a default for the scanner source adf_mode. Some scanners
throw an error even when the selection if supported.
- Add a "Quick Download" action to reduce the number of steps to download
a single document. GitLab issue #338.
- Recalculate a document's indexes when attaching or removing a tag from or
to it.
- Recalculate all of a tag's documents when a tag is about to be deleted.
Removals
--------
* Data filters app.
* DOCUMENTS_LANGUAGE_CHOICES setting option. Replaced with
DOCUMENTS_LANGUAGE_CODES.
* ``DOCUMENTS_LANGUAGE_CHOICES`` setting option. Replaced with
``DOCUMENTS_LANGUAGE_CODES``.
Known issues
------------
The newly added 'flanker' dependency used to process email, produces a number
of warnings on the console that are imposible to turn off. These are not
critical and are related to coding practices in the library. All warning
@@ -544,9 +585,8 @@ Example: "WARNING:flanker.addresslib._parser.parser:Symbol 'domain' is unreachab
Upgrading from a previous version
---------------------------------
Using PIP
~~~~~~~~~
^^^^^^^^^
Type in the console::
@@ -556,7 +596,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -572,7 +612,7 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Migrate existing database schema with::
@@ -586,44 +626,45 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* `GitLab issue #211 <https://gitlab.com/mayan-edms/mayan-edms/issues/211>`_ Remove all workflows when removing them from a document type
* `GitLab issue #262 <https://gitlab.com/mayan-edms/mayan-edms/issues/262>`_ Event notifications
* `GitLab issue #278 <https://gitlab.com/mayan-edms/mayan-edms/issues/278>`_ Detect non migrated models
* `GitLab issue #302 <https://gitlab.com/mayan-edms/mayan-edms/issues/302>`_ 'New Document' button available to users who do not have permission
* `GitLab issue #332 <https://gitlab.com/mayan-edms/mayan-edms/issues/332>`_ Add option to pass configuration parameters to the OCR backend as mentioned in #319
* `GitLab issue #338 <https://gitlab.com/mayan-edms/mayan-edms/issues/338>`_ Quick download link in documents list view
* `GitLab issue #370 <https://gitlab.com/mayan-edms/mayan-edms/issues/370>`_ Advanced search appears to OR the fields instead of AND them
* `GitLab issue #380 <https://gitlab.com/mayan-edms/mayan-edms/issues/380>`_ Features removal for version 3.0
* `GitLab issue #405 <https://gitlab.com/mayan-edms/mayan-edms/issues/405>`_ Add wizard steps from external apps
* `GitLab issue #407 <https://gitlab.com/mayan-edms/mayan-edms/issues/407>`_ Improve search syntax to support search query types: AND, OR
* `GitLab issue #408 <https://gitlab.com/mayan-edms/mayan-edms/issues/408>`_ Improve document checkbox selection.
* `GitLab issue #420 <https://gitlab.com/mayan-edms/mayan-edms/issues/420>`_ Mayan raises a 500 instead of 404 in production mode
* `GitLab issue #427 <https://gitlab.com/mayan-edms/mayan-edms/issues/427>`_ /tmp/mayan_locks.tmp is always owned by root
* `GitLab issue #430 <https://gitlab.com/mayan-edms/mayan-edms/issues/430>`_ Can't use STATICFILES_STORAGE that requires running collectstatic first
* `GitLab issue #437 <https://gitlab.com/mayan-edms/mayan-edms/issues/437>`_ Record users who upload or edit documents
* `GitLab issue #439 <https://gitlab.com/mayan-edms/mayan-edms/issues/439>`_ Toastr library missing after update
* `GitLab issue #444 <https://gitlab.com/mayan-edms/mayan-edms/issues/444>`_ Error in retrieving documents via POP3
* `GitLab issue #446 <https://gitlab.com/mayan-edms/mayan-edms/issues/446>`_ Document searcher
* `GitLab issue #447 <https://gitlab.com/mayan-edms/mayan-edms/issues/447>`_ API Security Bug Chinese wall breach
* `GitLab issue #449 <https://gitlab.com/mayan-edms/mayan-edms/issues/449>`_ OCR Error: 'int' object has no attribute 'split'
* `GitLab issue #452 <https://gitlab.com/mayan-edms/mayan-edms/issues/452>`_ Workflow ACL Doesn't works
* `GitLab issue #454 <https://gitlab.com/mayan-edms/mayan-edms/issues/454>`_ Invalid next month calculation in statistics app, causes failstop
* `GitLab issue #467 <https://gitlab.com/mayan-edms/mayan-edms/issues/467>`_ mail attachments without content-disposition are lost
* `GitLab issue #468 <https://gitlab.com/mayan-edms/mayan-edms/issues/468>`_ plain text e-mails without charset do not work
* `GitLab issue #470 <https://gitlab.com/mayan-edms/mayan-edms/issues/470>`_ Enable Django variable for HTML encoded emails
* `GitLab issue #474 <https://gitlab.com/mayan-edms/mayan-edms/issues/474>`_ Provide option to serve Mayan EDMS without a webserver (using Tornado o similar).
* `GitLab issue #480 <https://gitlab.com/mayan-edms/mayan-edms/issues/480>`_ Wrong Environment Variables names in documentation
* `GitLab issue #481 <https://gitlab.com/mayan-edms/mayan-edms/issues/481>`_ IMAP sources with metadata not working in 3.0rc1
* `GitLab issue #484 <https://gitlab.com/mayan-edms/mayan-edms/issues/484>`_ Document upload wizard only works as admin
* :gitlab-issue:`211` Remove all workflows when removing them from a document type
* :gitlab-issue:`262` Event notifications
* :gitlab-issue:`278` Detect non migrated models
* :gitlab-issue:`302` 'New Document' button available to users who do not have permission
* :gitlab-issue:`332` Add option to pass configuration parameters to the OCR backend as mentioned in #319
* :gitlab-issue:`338` Quick download link in documents list view
* :gitlab-issue:`370` Advanced search appears to OR the fields instead of AND them
* :gitlab-issue:`380` Features removal for version 3.0
* :gitlab-issue:`405` Add wizard steps from external apps
* :gitlab-issue:`407` Improve search syntax to support search query types: AND, OR
* :gitlab-issue:`408` Improve document checkbox selection.
* :gitlab-issue:`420` Mayan raises a 500 instead of 404 in production mode
* :gitlab-issue:`427` /tmp/mayan_locks.tmp is always owned by root
* :gitlab-issue:`430` Can't use STATICFILES_STORAGE that requires running collectstatic first
* :gitlab-issue:`437` Record users who upload or edit documents
* :gitlab-issue:`439` Toastr library missing after update
* :gitlab-issue:`444` Error in retrieving documents via POP3
* :gitlab-issue:`446` Document searcher
* :gitlab-issue:`447` API Security Bug Chinese wall breach
* :gitlab-issue:`449` OCR Error: 'int' object has no attribute 'split'
* :gitlab-issue:`452` Workflow ACL Doesn't works
* :gitlab-issue:`454` Invalid next month calculation in statistics app, causes failstop
* :gitlab-issue:`467` mail attachments without content-disposition are lost
* :gitlab-issue:`468` plain text e-mails without charset do not work
* :gitlab-issue:`470` Enable Django variable for HTML encoded emails
* :gitlab-issue:`474` Provide option to serve Mayan EDMS without a webserver (using Tornado o similar).
* :gitlab-issue:`480` Wrong Environment Variables names in documentation
* :gitlab-issue:`481` IMAP sources with metadata not working in 3.0rc1
* :gitlab-issue:`484` Document upload wizard only works as admin
* `GitHub issue #264 <https://github.com/mayan-edms/mayan-edms/issues/264>`_ migrate fails on document_states 0004_workflow_internal_name
* `GitHub issue #269 <https://github.com/mayan-edms/mayan-edms/issues/269>`_ Lack of authentication for document previews
* :github-issue:`264` migrate fails on document_states 0004_workflow_internal_name
* :github-issue:`269` Lack of authentication for document previews
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

23
docs/releases/3.1.1.rst
View File

@@ -1,23 +1,26 @@
===============================
Mayan EDMS v3.1.1 release notes
===============================
Version 3.1.1
=============
Released: September 18, 2018
Changes
-------
- CSS tweak to make sure the AJAX spinner stays in place.
- Fix 90, 180 and 270 degrees rotation transformations.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -31,7 +34,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -51,7 +54,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -66,12 +70,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

22
docs/releases/3.1.2.rst
View File

@@ -1,9 +1,11 @@
===============================
Mayan EDMS v3.1.2 release notes
===============================
Version 3.1.2
=============
Released: September 21, 2018
Changes
-------
- Database access in data migrations defaults to the 'default' database.
Force it to the user selected database instead.
- Don't use a hardcoded database alias for the destination of the
@@ -25,17 +27,19 @@ Released: September 21, 2018
- Intercept document list view exception and display them as an error
message.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -49,7 +53,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -69,7 +73,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -84,12 +89,13 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
---------------------------
* None

32
docs/releases/3.1.3.rst
View File

@@ -1,29 +1,33 @@
===============================
Mayan EDMS v3.1.3 release notes
===============================
Version 3.1.3
=============
Released: September 26, 2018
Changes
-------
* Make sure template API renders in non US languages.
* Fix user groups view.
* Add no results help text to the document type -> metadata type
association view.
* Expose the Django INSTALLED_APPS setting.
* Expose the Django ``INSTALLED_APPS`` setting.
* Add support for changing the concurrency of the Celery workers in the
Docker image. Add environment variables MAYAN_WORKER_FAST_CONCURRENCY,
MAYAN_WORKER_MEDIUM_CONCURRENCY and MAYAN_WORKER_SLOW_CONCURRENCY.
Docker image. Add environment variables ``MAYAN_WORKER_FAST_CONCURRENCY``,
``MAYAN_WORKER_MEDIUM_CONCURRENCY`` and ``MAYAN_WORKER_SLOW_CONCURRENCY``.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -37,7 +41,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -57,7 +61,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -72,13 +77,14 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #513 <https://gitlab.com/mayan-edms/mayan-edms/issues/513>`_ Unicode problem on GET '/api/templates/main_menu/' with german translation
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`513` Unicode problem on GET '/api/templates/main_menu/' with german translation
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

37
docs/releases/3.1.4.rst
View File

@@ -1,11 +1,15 @@
===============================
Mayan EDMS v3.1.4 release notes
===============================
Version 3.1.4
=============
Released: October 4, 2018
Changes
-------
Improved search logic
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
The previous search code was optimized for speed and this was
achieved by analyzing and then performing searches on a field
basis and then on a term basis, merging the results. This
@@ -22,8 +26,10 @@ The word 'AND' is now explicitly supported and interpreted
to be a search syntax modifier. Adding 'AND' will not affect
the search results.
Indexing by OCR text
~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^
The indexing system has been updated to respond to the signal
raise when the OCR engine finished processing a document. This
allows the system to update location of a document in the
@@ -45,7 +51,8 @@ The same applies to text content extracted for the document::
Other changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
* Fix the link to the documentation. Closes GitLab issue #516.
Thanks to Matthias Urlichs @smurfix for the report.
* Update related links. Add links to the new Wiki and Forum.
@@ -62,17 +69,19 @@ Other changes
for the report.
* Add explanation to the launch workflows tool.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -86,7 +95,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -106,7 +115,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -125,10 +135,11 @@ Backward incompatible changes
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #516 <https://gitlab.com/mayan-edms/mayan-edms/issues/516>`_ The readthedocs.io link is broken (page doesn't exist).
* `GitLab issue #517 <https://gitlab.com/mayan-edms/mayan-edms/issues/517>`_ Quotes in workflow state document web browser title
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`516` The readthedocs.io link is broken (page doesn't exist).
* :gitlab-issue:`517` Quotes in workflow state document web browser title
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

52
docs/releases/3.1.5.rst
View File

@@ -1,11 +1,15 @@
===============================
Mayan EDMS v3.1.5 release notes
===============================
Version 3.1.5
=============
Released: October 8, 2018
Changes
-------
Index mirroring fixes
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
This release fixes the mountindex management command that mounts an index
as a FUSE filesystem. It also includes a fix for indexes that return a
multi line value. The carriage returns and newlines characters are now
@@ -14,30 +18,39 @@ Lastly an issue with the duplicated value was fixed. Indexes levels that
return a duplicated value will now show as directory entried when mounted
as a FUSE filesystem.
Page parsed text link
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
Recently a link was added to each document page to show the OCR text for
that particular page. This release adds another link but to allow users
to view the parsed text of each page.
Python 3
~~~~~~~~
^^^^^^^^
This release includes several fixes for Python 3 compatibility and reduce
the fail count of the test suit to just one test.
Transformations arguments
~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^
Visually the view to create or edit a transformation remains the same. But
internally those views now use an explicit form to allow performing YAML
format validation of arguments.
Crop transformation
~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^
Stricter error checking was added to the crop transformation.
Other changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
* Consolidate some document indexing test code into a new mixin.
* Update compressed files class module to work with Python 3.
* Update document parsing app tests to work with Python 3.
@@ -63,17 +76,18 @@ Other changes
metadata types. Closes GitLab issue #521. Thanks to the TheOneValen
@TheOneValen for the report.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -87,7 +101,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -107,7 +121,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -126,11 +141,12 @@ Backward incompatible changes
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #518 <https://gitlab.com/mayan-edms/mayan-edms/issues/518>`_ mountindex broken (3.1.x)
* `GitLab issue #519 <https://gitlab.com/mayan-edms/mayan-edms/issues/519>`_ Mail body fetched despite setting not to
* `GitLab issue #521 <https://gitlab.com/mayan-edms/mayan-edms/issues/521>`_ Adding multiple metadata at once fails
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`518` mountindex broken (3.1.x)
* :gitlab-issue:`519` Mail body fetched despite setting not to
* :gitlab-issue:`521` Adding multiple metadata at once fails
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

28
docs/releases/3.1.6.rst
View File

@@ -1,11 +1,12 @@
===============================
Mayan EDMS v3.1.6 release notes
===============================
Version 3.1.6
=============
Released: October 9, 2018
Changes
~~~~~~~
-------
* Improve index mirroring value clean up code to remove the spaces at the
starts and at the end of directories. Closes again GitLab issue #520
Thanks to TheOneValen @ for the report.
@@ -18,17 +19,18 @@ Changes
* Add icon to the cabinet "Add new level" link.
* Display the cabinet "Add new level" link in the top level view too.
Removals
--------
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -42,7 +44,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -62,7 +64,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -81,10 +84,11 @@ Backward incompatible changes
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #518 <https://gitlab.com/mayan-edms/mayan-edms/issues/518>`_ mountindex broken (3.1.x)
* `GitLab issue #520 <https://gitlab.com/mayan-edms/mayan-edms/issues/520>`_ Newline handling in template expression for index when mounting the index
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`518` mountindex broken (3.1.x)
* :gitlab-issue:`520` Newline handling in template expression for index when mounting the index
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

25
docs/releases/3.1.7.rst
View File

@@ -1,11 +1,11 @@
===============================
Mayan EDMS v3.1.7 release notes
===============================
Version 3.1.7
=============
Released: October 14, 2018
Changes
~~~~~~~
-------
* Fix an issue with some browsers not firing the .load event on cached
images. Ref: http://api.jquery.com/load-event/
* Remove duplicate YAML loading of environment variables.
@@ -26,6 +26,7 @@ Changes
environment variable to ocr.backends.pyocr.PyOCR to use this.
* All tests pass on Python 3.
Removals
--------
@@ -36,7 +37,7 @@ Upgrading from a previous version
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -50,7 +51,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -70,7 +71,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -89,10 +91,11 @@ Backward incompatible changes
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #525 <https://gitlab.com/mayan-edms/mayan-edms/issues/525>`_ path to SECRET_KEY in entrypoint.sh seems to be a mistake
* `GitLab issue #527 <https://gitlab.com/mayan-edms/mayan-edms/issues/527>`_ Celery concurrency flag names don't match
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`525` path to SECRET_KEY in entrypoint.sh seems to be a mistake
* :gitlab-issue:`527` Celery concurrency flag names don't match
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

26
docs/releases/3.1.8.rst
View File

@@ -1,11 +1,11 @@
===============================
Mayan EDMS v3.1.8 release notes
===============================
Version 3.1.8
=============
Released: October XX, 2018
Changes
~~~~~~~
-------
Removals
@@ -13,12 +13,12 @@ Removals
* None
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -32,7 +32,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -52,7 +52,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -71,10 +72,11 @@ Backward incompatible changes
* None
Bugs fixed or issues closed
===========================
* `GitLab issue #529 <https://gitlab.com/mayan-edms/mayan-edms/issues/529>`_ Submitting a metadata value with the `&` character truncates string
* `GitLab issue #530 <https://gitlab.com/mayan-edms/mayan-edms/issues/530>`_ Email Link form does not accept commas or semicolons to separate multiple addresses
Bugs fixed or issues closed
---------------------------
* :gitlab-issue:`592` Submitting a metadata value with the `&` character truncates string
* :gitlab-issue:`530` Email Link form does not accept commas or semicolons to separate multiple addresses
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

142
docs/releases/3.1.rst
View File

@@ -1,11 +1,10 @@
=============================
Mayan EDMS v3.1 release notes
=============================
Version 3.1
===========
Released: September 17, 2018
What's new
==========
Changes
-------
When one hears the word software bug, one first think of critical errors.
We might think about data loss, privacy issues or user interface breakage.
@@ -21,7 +20,8 @@ terms of features or improvement to existing feature but also focused in fixing
Client side caching of images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mayan EDMS already does extensive caching of content. Currently the caching
happens on the environment running the Python code. This release adds code
that allows browsers to cache some of the more used images like thumbnails
@@ -33,8 +33,10 @@ without user intervention. The amount of time images are cached in the browser
is determined by the new ``DOCUMENTS_PAGE_IMAGE_CACHE_TIME`` setting. This
setting defaults to 31556926 seconds which is equivalent to 1 year.
Web-based setting editing
~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^
Historically since most settings were performed modifying a Python setting file,
it was impossible or impractical to add a settings editor that worked using the
web interface. Over the last few versions we have been introducing updates
@@ -59,10 +61,11 @@ Example::
DOCUMENTS_ZOOM_PERCENT_STEP: 25
The second feature allow users to make changes to the settings options from the
web interface. Just navigate to [System] -> [Setup] -> [Settings]. Settings are
grouped by namespaces based on the app of type of system their control.
To change the default width of thumbnails, navigate to [Documents] ->
[DOCUMENTS_THUMBNAIL_WIDTH]
web interface. Just navigate to :menuselection:`System --> Setup --> Settings`.
Settings are grouped by namespaces based on the app of type of system their control.
To change the default width of thumbnails, navigate to
web interface. Just navigate to
:menuselection:`System --> Setup --> Settings --> Documents -> DOCUMENTS_THUMBNAIL_WIDTH`
and click on [Edit] to change the current value. Upon clicking on [Save] the
``config.yml`` will be updated to include this new value. A restart of the installation
is required to make the change effective. This is not a Mayan limitation but a
@@ -103,8 +106,10 @@ deployment. This settings hierarchy is as follows:
4- Setting modified via the new web interface, which upon saved will overwrite the
``mayan/config.yml`` file.
Customization
~~~~~~~~~~~~~
^^^^^^^^^^^^^
Along with improvements in the ease of customizing Mayan, we've added more
even more customization options via new settings. We've added the
``COMMON_PROJECT_TITLE`` setting to allow administrator to change the name of their
@@ -112,8 +117,10 @@ deployments without having to make code changes. We added several base Django
settings to allow how administrative emails are sent (like the password recovery
emails). These new settings can be found in their one namespace, named "Django".
Database conversion improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This release adds support for natural keys to many models. This feature
allows exporting data in a format that is database agnostic so that it can then
be imported back using a different database engine. With this feature eases
@@ -121,10 +128,12 @@ the migration from SQLite to other database managers like PostgreSQL, MySQL or
MariaDB.
The export and import can be done using the dumpdata and loaddata command or
the new command convertdb.
the new command ``convertdb``.
Changed settings
~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^
We renamed the setting ``LOCK_MANAGER_DEFAULT_BACKEND`` to ``LOCK_MANAGER_BACKEND``.
Functionally it exactly the same but the addition of the term 'DEFAULT` was
confusing users so it was removed.
@@ -142,7 +151,8 @@ must be updated to::
Workflow improvements
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
We fixed an minor issue that prevented actions attached to initial states to
execute reliably. Similarly we added support for viewing only the events of a
tag via a new events link for tags.
@@ -157,8 +167,10 @@ From the {{ document }} variable, properties like metadata and tags are availabl
This allows those properties to be used when changing the label or the
description of the document.
Event changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
It is now possible to view the events of a document type via a new events links
associated to the document type.
@@ -170,8 +182,10 @@ a metadata field.
Events were added to track the creation and editing of tags.
Permission changes
~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^
Add new document indexing permission was added. This permission allow users
to view an index instance as opposed to the current permission which allows
viewing an index definition on the setup menu. This new permission allows
@@ -188,8 +202,10 @@ ACL support was added to the message of the day app. The index rebuild
permission can now be set as part of the index ACL for each individual index.
This allow granting the access to rebuild some indexes to specific roles.
Smarter menu and link display
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Support was added to conditionally disable menus. This gives an user a clearer
idea of the section they can access. Previously menus were always displayed
even if an user didn't have access to any of the objects in that menu. Now
@@ -202,15 +218,19 @@ be removed from view. Most entries in the main menu have been updated to support
this new feature. For now this feature is mostly used in the main menu, and in the
Tools and System menus.
Document sorting
~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^
We've been researching methods to provide a way to sort documents via the user
interface. Efforts continue towards this goal but for the time being we've
settled on the common request to sort documents by label. This provides a quick
method to scan documents visually using a custom sorting feature is added.
Transformations
~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^
The rotate transformation now has a new argument. This argument is named
``fillcolor`` and is used to provide a background color to fill the blank areas
after rotating a document. The arguments uses the web notation of three color
@@ -218,14 +238,18 @@ indicating the red, green and blue components of the color in unit of 0 to 255
or 0 to FF as hexadecimal is used. For example white is '#FFFFFF', red is
'#FF0000', green is '#00FF00' and so on.
Link sorting
~~~~~~~~~~~~
^^^^^^^^^^^^
Another papercut solved was the sorting of the links to help visual scan.
The action in the multiple document dropdown are now sorted alphabetically.
This is also true for the actions in the facet, secondary and sidebar sections.
Blanks views and auto documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Previously when an user navigated to a view with no results a simple "No results"
message was displayed. This has now been improved with a new template that will
display several pieces of information. An icon will be displayed to help the user
@@ -241,8 +265,10 @@ something other than a blank template.
This update help users understand what they are supposed to do in specific
views and act as a built in reference for the terminology used in Mayan.
Password changes
~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^
Some installations allow for demo or read only access. For example some
installations of Mayan used in governments provide a free read only account
for citizen access. This feature allow administrators to block the ability of these
@@ -251,15 +277,19 @@ feature was added into a user account view accessible via a new user link. It
can be found in the user list view. Next to each user entry a new button
called [User options] was added.
Document page view changes
~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^
To improve usability after searching for a term a link to examine the OCR of each
page was added. The link can be found in the [Action] dropdown in the page list
view or when examining a single document page in the top facet menu next to the
transformations link.
Dashboard changes
~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^
The dashboard widget system has been refactored to make it class based. This
allows developers to subclass the base class for the dashboard widget and more
easily add their own widget system. The new widget class can also access
@@ -271,8 +301,10 @@ ACL filtering has added to the default widgets. This way users cannot get
access to the knowledge or the total number documents in the system. The totals
displayed in the dashboard widgets be updated based on the user's access controls.
Chart changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
The statistics class system was refactored to improve the subclassing support.
The class module was split into statistic classes and renderer classes to support
new frontend rendering libraries. This will allow developer to add other chart
@@ -280,15 +312,16 @@ classes beyond the provide line chart.
Other changes
~~~~~~~~~~~~~
^^^^^^^^^^^^^
- Add recently added document list view. The setting
DOCUMENTS_RECENT_COUNT has been renamed to
DOCUMENTS_RECENT_ACCESS_COUNT. New setting
DOCUMENTS_RECENT_ADDED_COUNT added.
``DOCUMENTS_RECENT_COUNT`` has been renamed to
``DOCUMENTS_RECENT_ACCESS_COUNT``. New setting
``DOCUMENTS_RECENT_ADDED_COUNT`` added.
- Fix crop transformation argument parsing. Thanks to Jordan Wages
(@wagesj45). Closes GitLab issue #490
- Add error checking to the crop transformation arguments.
- Fix post login redirection to honor the ?next= URL query string
- Fix post login redirection to honor the ``?next=`` URL query string
argument. Thanks go to K.C. Wong (@dvusboy1). Closes GitLab
issue #489.
- Update dropzone.js' timeout from 30 seconds to 120 to allow upload
@@ -305,10 +338,10 @@ Other changes
- Speed up document image fade in reveal.
- Use reseteable timer to ensure more document panels heights are matched.
- Rewrote Mayan's Javascript suite MayanApp into ECMAScript2015.
- Remove use is waitForJQuery.
- Remove use of ``waitForJQuery``.
- Remove code statistics from the documentation.
- Remove the pending work chapter. This is now available in the Wiki:
wiki.mayan-edms.com
https://wiki.mayan-edms.com
- Unify template title rendering.
- Add support for template subtitles.
- Add the tag events view permissions to the tag model ACL.
@@ -328,11 +361,11 @@ Other changes
- Only show the settings namespace list link where it is
relevant.
- Use platform independent hashing for transformations.
- Add support to the ObjectActionMixin to report on instance action
- Add support to the ``ObjectActionMixin`` to report on instance action
failures. Add also an error_message class property and the new
ActionError exception.
``ActionError`` exception.
- Add favorite documents per user. Adds new setting option
DOCUMENTS_FAVORITE_COUNT.
``DOCUMENTS_FAVORITE_COUNT``.
- In addition to the document view permission, the checkout detail
view permission is now needed to view the list of checked out
document.
@@ -343,7 +376,7 @@ Other changes
permissions is now required to view the parsing error list.
- The document type parsing setup permission can now be granted for
individual document types.
- Remove the duplicated setting pdftotext_path from the OCR path.
- Remove the duplicated setting ``pdftotext_path`` from the OCR path.
This is now handled by the document parsing app.
- Implement partial refresh of the main menu.
- Complete refactor of the compress archive class support. Closes
@@ -354,12 +387,12 @@ Other changes
#360.
- Add new dashboard item to display the total page count.
- Show the document type being uploaded in the source view title.
- Setting SOURCE_SCANIMAGE_PATH is now SOURCES_SCANIMAGE_PATH.
- Setting ``SOURCE_SCANIMAGE_PATH`` is now ``SOURCES_SCANIMAGE_PATH``.
- Refactor the staging file image generation to support
background task generation, caching and cache sharing.
- New queue: sources_fast. Used for staging file generation.
- New settings: SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND and
SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND_ARGUMENTS to control
- New settings: ``SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND`` and
``SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND_ARGUMENTS`` to control
where and how staging file caching is done.
- Fix an egde case on the document indexing where an empty
node could be left behind.
@@ -370,17 +403,18 @@ Other changes
templates that only refresh the menu when there are changes.
Closes GitLab issue #511. Thanks to Daniel Carrico
@daniel1113 for the report.
- Refactor the ModelAttribute class into two separate classes:
ModelAttribute for executable model attributes and ModelField
- Refactor the ``ModelAttribute`` class into two separate classes:
``ModelAttribute`` for executable model attributes and ``ModelField``
for actual ORM fields.
- Expose more document fields for use in smart links.
- The size of the document type label field has been increased
from 32 to 96 characters.
- Add file_size and datetime fields to the DocumentPageCachedImage
- Add file_size and datetime fields to the ``DocumentPageCachedImage``
model.
- Make icon classes file template based.
- Add the current step and total steps of a wizard in the template context.
Removals
--------
@@ -394,9 +428,8 @@ Removals
Upgrading from a previous version
---------------------------------
If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove deprecated requirements::
@@ -410,7 +443,7 @@ the requirements will also be updated automatically.
Using Git
~~~~~~~~~
^^^^^^^^^
If you installed Mayan EDMS by cloning the Git repository issue the commands::
@@ -430,7 +463,8 @@ Next upgrade/add the new requirements::
Common steps
~~~~~~~~~~~~
^^^^^^^^^^^^
Perform these steps after updating the code from either step above.
Migrate existing database schema with::
@@ -445,7 +479,7 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* ``LOCK_MANAGER_DEFAULT_BACKEND`` was renamed to ``LOCK_MANAGER_BACKEND``.
* ``ALLOWED_HOSTS`` is interpreted as YAML.
@@ -458,11 +492,11 @@ must be changed::
Bugs fixed or issues closed
===========================
---------------------------
* `GitLab issue #7 <https://gitlab.com/mayan-edms/mayan-edms/issues/7>`_ Feature: other compressors than zip for compressed documents
* `GitLab issue #259 <https://gitlab.com/mayan-edms/mayan-edms/issues/259>`_ Thumbnails: why are they created on the fly (therefore: not cached)
* `GitLab issue #360 <https://gitlab.com/mayan-edms/mayan-edms/issues/360>`_ Should quick rename (optionally) retain original file type extension?
* `GitLab issue #511 <https://gitlab.com/mayan-edms/mayan-edms/issues/511>`_ Menu bar flickering in 3.1b1
* :gitlab-issue:`7` Feature: other compressors than zip for compressed documents
* :gitlab-issue:`259` Thumbnails: why are they created on the fly (therefore: not cached)
* :gitlab-issue:`360` Should quick rename (optionally) retain original file type extension?
* :gitlab-issue:`511` Menu bar flickering in 3.1b1
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

2
docs/topics/administration.rst
View File

@@ -6,4 +6,6 @@ Administration
.. include:: ../chapters/languages.rst
.. include:: ../chapters/password_reset.rst
.. include:: ../chapters/ocr_backend.rst
.. include:: ../chapters/backups.rst
.. include:: ../chapters/scaling_up.rst
.. include:: ../chapters/database_conversion.rst

8
docs/topics/faq.rst
View File

@@ -98,7 +98,6 @@ _mysql_exceptions. OperationalError: (1267, "Illegal mix of collations (latin1_s
References:
* http://www.djangoshmango.com/?p=99
* http://stackoverflow.com/questions/1073295/django-character-set-with-mysql-weirdness
@@ -111,6 +110,7 @@ Use utf-8 collation on MySQL server, or at least in table
‘documents_documentpage', ‘content' field
References:
* http://groups.google.com/group/django-users/browse_thread/thread/429447086fca6412
* http://markmail.org/message/bqajx2utvmtriixi
@@ -188,10 +188,8 @@ testing. For production deployments the management command::
$ mayan-edms.py collectstatic
should be used and the resulting static folder served from a webserver.
For more information,
read https://docs.djangoproject.com/en/dev/howto/static-files/ and
https://docs.djangoproject.com/en/1.2/howto/static-files/ or
http://mayan-edms-ru.blogspot.com/2011/11/blog-post_09.html
For more information check the
:django-docs:`howto/static-files/`
Watchfolders
============

4
docs/topics/installation.rst
View File

@@ -34,7 +34,7 @@ script follow the instructions outlined in their documentation: https://docs.doc
Once the Docker installation is finished, proceed to the link below to install
the Docker image for Mayan EDMS.
Docker image chapter: :ref:`docker`
Docker image chapter: :ref:`docker_install`
*******************
Direct installation
@@ -42,7 +42,7 @@ Direct installation
For users with knowledge of Python, Django, Ubuntu, and databases.
Deployments chapter: :ref:`deploying`
Deployments chapter: :doc:`../chapters/deploying`
.. _Docker: https://www.docker.com/

7
docs/topics/maintenance.rst
View File

@@ -1,7 +0,0 @@
###########
Maintenance
###########
.. include:: ../chapters/backups.rst

1
docs/topics/settings.rst
View File

@@ -1,2 +1 @@
.. include:: ../chapters/settings.rst

3
mayan/__init__.py
View File

@@ -3,7 +3,8 @@ from __future__ import unicode_literals
__title__ = 'Mayan EDMS'
__version__ = '3.1.7'
__build__ = 0x030107
__build_string__ = 'v3.1.7_Sun Oct 14 03:51:25 2018 -0400'
__build_string__ = 'v3.1.7-16-g0e4c7d1243_Thu Oct 18 16:27:16 2018 -0400'
__django_version__ = '1.11'
__author__ = 'Roberto Rosario'
__author_email__ = 'roberto.rosario@mayan-edms.com'
__description__ = 'Free Open Source Electronic Document Management System'