Merge remote-tracking branch 'origin/master' into development
Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
74
docs/releases/2.5.1.rst
Normal file
74
docs/releases/2.5.1.rst
Normal file
@@ -0,0 +1,74 @@
|
||||
===============================
|
||||
Mayan EDMS v2.5.1 release notes
|
||||
===============================
|
||||
|
||||
Released: July 07, 2017
|
||||
|
||||
What's new
|
||||
==========
|
||||
|
||||
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::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
The upgrade procedure is now complete.
|
||||
|
||||
|
||||
Backward incompatible changes
|
||||
=============================
|
||||
|
||||
* None
|
||||
|
||||
Bugs fixed or issues closed
|
||||
===========================
|
||||
|
||||
<<<<<<< HEAD:docs/releases/2.5.1.rst
|
||||
* None
|
||||
=======
|
||||
* `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.
|
||||
|
||||
>>>>>>> 105eab074... Add new document version list view permission. GitLab issue #379:docs/releases/3.0.rst
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
74
docs/releases/2.5.2.rst
Normal file
74
docs/releases/2.5.2.rst
Normal file
@@ -0,0 +1,74 @@
|
||||
===============================
|
||||
Mayan EDMS v2.5.2 release notes
|
||||
===============================
|
||||
|
||||
Released: July 08, 2017
|
||||
|
||||
What's new
|
||||
==========
|
||||
|
||||
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
|
||||
transaction was split into smaller units to make sure the duplicate scan
|
||||
recevies saved and committed data.
|
||||
|
||||
|
||||
Removals
|
||||
--------
|
||||
* None
|
||||
|
||||
Upgrading from a previous version
|
||||
---------------------------------
|
||||
|
||||
Using PIP
|
||||
~~~~~~~~~
|
||||
|
||||
Type in the console::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
The upgrade procedure is now complete.
|
||||
|
||||
|
||||
Backward incompatible changes
|
||||
=============================
|
||||
|
||||
* None
|
||||
|
||||
Bugs fixed or issues closed
|
||||
===========================
|
||||
|
||||
* None
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
@@ -2,15 +2,139 @@
|
||||
Mayan EDMS v2.5 release notes
|
||||
=============================
|
||||
|
||||
Released: July XX, 2017
|
||||
Released: July 07, 2017
|
||||
|
||||
What's new
|
||||
==========
|
||||
|
||||
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
|
||||
allows for Mayan administrators to add mailing profiles without the
|
||||
intervention system administrators. It also provides the opportunity to create
|
||||
multiple mailing profiles. This is useful for sending documents via different
|
||||
email providers depending on things like priority of delivery, or email size
|
||||
limitations. For multi-tenant environments, this also means that each tenant
|
||||
can now send documents via email with their own respective email accounts.
|
||||
For system administrators, this means there is no longer a need to rely on a
|
||||
single email profile for the entirety of all the tenants in a deployment,
|
||||
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
|
||||
from the "Profile" menu to the new "System" menu. The "Profile" menu has been
|
||||
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
|
||||
but does not force users to remove a metadata type before making the switch
|
||||
and thus avoid deletion of existing metadata entries. A new view was also added
|
||||
to change the document type to metadata type relation not only the document
|
||||
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
|
||||
is a duplicate of an existing document. Duplicate documents will be listed
|
||||
in a new "Duplicated documents" link in the main menu. A full document list
|
||||
scan can also be triggered by using the new "Duplicated document scan" button
|
||||
in the tools menu. Finally, a new tab in the document view has been added
|
||||
called "Duplicates" that will list all duplicates of the currently
|
||||
selected document when in the document's view. Related to this feature is the
|
||||
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"
|
||||
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
|
||||
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
|
||||
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
|
||||
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 view to download a document's OCR text. GitLab issue #215.
|
||||
- Add missing OCR migration.
|
||||
- Improve error output of the performupgrade command to debug upgrade errors
|
||||
that could stop an upgrade (missing document files, etc).
|
||||
@@ -23,21 +147,15 @@ Other Changes
|
||||
- Rename the mayan_task_manager app to task_manager.
|
||||
- Make the task manager translatable.
|
||||
- Add Turkish to the list of processes languages.
|
||||
- Add user configurable mailer support. GitLab issue #286.
|
||||
- Use Toastr libary for screen messages.
|
||||
- Reduce verbosity of some debug messages.
|
||||
- New lineart transformation. Useful to increase the OCR accuracy on some kind
|
||||
of documents.
|
||||
- Reduce verbosity of some debug messages in the MayanAppConfig, settings and,
|
||||
mailing discovery.
|
||||
- Make sure lookup selection widgets also trigger the metadata update
|
||||
checkbox on change.
|
||||
- Menu reorganization. The "About" menu has been renamed to "System". The
|
||||
"Tools" and "Setup" sub menus, were moved from the "Profile" menu to the
|
||||
"System" menu. The "Profile" menu has been renamed to "User".
|
||||
- Usability improvements on small displays.
|
||||
- Removal of the CONVERTER_LIBREOFFICE_PATH and CONVERTER_PDFTOPPM_PATH
|
||||
settings. These setting have been consolidated into
|
||||
CONVERTER_GRAPHICS_BACKEND_CONFIG.
|
||||
- PDF compatibility improvements.
|
||||
- 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
|
||||
@@ -45,15 +163,23 @@ Other Changes
|
||||
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
|
||||
- Document type-metadata type relationship. Add new UI method to switch between
|
||||
required metadata and optional metadata for a document type. This new
|
||||
method does not forces users to remove a metadata type before making the
|
||||
switch and thus avoid deletion of existing metadata entries. GitLab issue #337.
|
||||
- It is now possible to change the relationship between metadata types and
|
||||
document types from either the metadata type list or document type list.
|
||||
GitLab issue #373.
|
||||
- Add support to search documents by their checksums.
|
||||
- The document checksum field is now indexed for faster searches by checksum.
|
||||
- The trashed document deletion action is now a background task. This
|
||||
feature results is much faster trashed document deletion and trash
|
||||
can emptying.
|
||||
- Remove animated spinners to lower browser memory usage and increase
|
||||
responsiveness.
|
||||
- Render a document page placeholder while the real document page
|
||||
loads. This change avoids "jumping" effect when loading many thumbnails.
|
||||
- Increase lazy load thresholds. More thumbnails and document pages
|
||||
will be loaded and visible by default when a view loads.
|
||||
- Improve usability and appearance on medium and small devices like
|
||||
tablets and smartphones.
|
||||
- Do hard word break on form titles to avoid horizontal scroll on
|
||||
small displays.
|
||||
- Python3 compatilibty improvements by removing all explicit conversion
|
||||
using the unicode() function.
|
||||
- Unicode handling improvements.
|
||||
- Update required versions of Pillow and django-suit.
|
||||
|
||||
Removals
|
||||
--------
|
||||
|
||||
69
docs/releases/2.6.1.rst
Normal file
69
docs/releases/2.6.1.rst
Normal file
@@ -0,0 +1,69 @@
|
||||
=============================
|
||||
Mayan EDMS v2.6 release notes
|
||||
=============================
|
||||
|
||||
Released: July 18, 2017
|
||||
|
||||
What's new
|
||||
==========
|
||||
|
||||
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::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
The upgrade procedure is now complete.
|
||||
|
||||
|
||||
Backward incompatible changes
|
||||
=============================
|
||||
|
||||
* None
|
||||
|
||||
Bugs fixed or issues closed
|
||||
===========================
|
||||
|
||||
* None
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
78
docs/releases/2.6.2.rst
Normal file
78
docs/releases/2.6.2.rst
Normal file
@@ -0,0 +1,78 @@
|
||||
===============================
|
||||
Mayan EDMS v2.6.2 release notes
|
||||
===============================
|
||||
|
||||
Released: July 22, 2017
|
||||
|
||||
What's new
|
||||
==========
|
||||
|
||||
This is a bug fix release and users are encouraged to upgrade.
|
||||
|
||||
Other 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.
|
||||
- Improve tag widget customization by moving the markup to its own template.
|
||||
- Fix document page widget appearance in the document page list view.
|
||||
- Make document version order deterministic.
|
||||
- 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::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
The upgrade procedure is now complete.
|
||||
|
||||
|
||||
Backward incompatible changes
|
||||
=============================
|
||||
|
||||
* None
|
||||
|
||||
Bugs fixed or issues closed
|
||||
===========================
|
||||
|
||||
* None
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
87
docs/releases/2.6.3.rst
Normal file
87
docs/releases/2.6.3.rst
Normal file
@@ -0,0 +1,87 @@
|
||||
===============================
|
||||
Mayan EDMS v2.6.3 release notes
|
||||
===============================
|
||||
|
||||
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
|
||||
with signals to allow customization from 3rd party apps.
|
||||
- PEP8 cleanups.
|
||||
- Add tag_ids keyword argument to the Source.handle_upload
|
||||
model method. GitLab issue #413.
|
||||
- Add overflow wrapping so wrap long titles in Firefox too.
|
||||
- Makes Roles searchable. GitLab issue #402.
|
||||
- Add line numbers to the debug and production loggers.
|
||||
Add date and time to the production logger.
|
||||
- Add support for generating setup.py from a template. GitLab
|
||||
#149 #200.
|
||||
- Add fade in animation to document images.
|
||||
|
||||
Removals
|
||||
--------
|
||||
* None
|
||||
|
||||
Upgrading from a previous version
|
||||
---------------------------------
|
||||
|
||||
Using PIP
|
||||
~~~~~~~~~
|
||||
|
||||
Type in the console::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
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
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
71
docs/releases/2.6.4.rst
Normal file
71
docs/releases/2.6.4.rst
Normal file
@@ -0,0 +1,71 @@
|
||||
===============================
|
||||
Mayan EDMS v2.6.4 release notes
|
||||
===============================
|
||||
|
||||
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::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
The upgrade procedure is now complete.
|
||||
|
||||
|
||||
Backward incompatible changes
|
||||
=============================
|
||||
|
||||
* None
|
||||
|
||||
Bugs fixed or issues closed
|
||||
===========================
|
||||
|
||||
* None
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
143
docs/releases/2.6.rst
Normal file
143
docs/releases/2.6.rst
Normal file
@@ -0,0 +1,143 @@
|
||||
=============================
|
||||
Mayan EDMS v2.6 release notes
|
||||
=============================
|
||||
|
||||
Released: July 18, 2017
|
||||
|
||||
What's new
|
||||
==========
|
||||
|
||||
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
|
||||
will be almost fullscreen. Another path from Macrobb Simpson, improves the
|
||||
visual appearance of the document metadata widget. The other big change is the
|
||||
new list item view template which lists documents in an column, row layout.
|
||||
With this layout document thumbnails are more clearly visible, much more
|
||||
information can be displayed for each document, and works much better on small
|
||||
screen devices like tablets and smartphone than a responsive table which
|
||||
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
|
||||
to add or remove documents from cabinets must also now be granted to a document
|
||||
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.
|
||||
- Switch the order of the DEFAULT_AUTHENTICATION_CLASSES of DRF. GitLab #400.
|
||||
- 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::
|
||||
|
||||
$ pip install -U mayan-edms
|
||||
|
||||
the requirements will also be updated automatically.
|
||||
|
||||
Using Git
|
||||
~~~~~~~~~
|
||||
|
||||
If you installed Mayan EDMS by cloning the Git repository issue the commands::
|
||||
|
||||
$ git reset --hard HEAD
|
||||
$ git pull
|
||||
|
||||
otherwise download the compressed archived and uncompress it overriding the
|
||||
existing installation.
|
||||
|
||||
Next upgrade/add the new requirements::
|
||||
|
||||
$ pip install --upgrade -r requirements.txt
|
||||
|
||||
Common steps
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Migrate existing database schema with::
|
||||
|
||||
$ mayan-edms.py performupgrade
|
||||
|
||||
Add new static media::
|
||||
|
||||
$ mayan-edms.py collectstatic --noinput
|
||||
|
||||
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
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||
@@ -22,6 +22,14 @@ versions of the documentation contain the release notes for any later releases.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
2.6.4
|
||||
2.6.3
|
||||
2.6.2
|
||||
2.6.1
|
||||
2.6
|
||||
2.5.2
|
||||
2.5.1
|
||||
2.5
|
||||
2.4
|
||||
2.3
|
||||
2.2
|
||||
|
||||
@@ -437,38 +437,42 @@ X.Y # Final release
|
||||
Release checklist
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Synchronize translations::
|
||||
1. Check for missing migrations::
|
||||
|
||||
$ ./manage.py makemigrations
|
||||
|
||||
2. Synchronize translations::
|
||||
|
||||
$ make translations_pull
|
||||
|
||||
2. Compile translations::
|
||||
3. Compile translations::
|
||||
|
||||
$ make translations_compile
|
||||
|
||||
3. Write release notes.
|
||||
4. Update changelog.
|
||||
5. Update requirements version in `setup.py`
|
||||
6. Bump version in `mayan/__init__.py`
|
||||
7. Build source package and test::
|
||||
4. Write release notes.
|
||||
5. Update changelog.
|
||||
6. Update requirements version in `setup.py`
|
||||
7. Bump version in `mayan/__init__.py`
|
||||
8. Build source package and test::
|
||||
|
||||
$ make test_sdist_via_docker_ubuntu
|
||||
|
||||
8. Build wheel package and test::
|
||||
9. Build wheel package and test::
|
||||
|
||||
$ make test_whell_via_docker_ubuntu
|
||||
|
||||
9. Tag version::
|
||||
10. Tag version::
|
||||
|
||||
$ git tag -a vX.Y.Z -m "Version X.Y.Z"
|
||||
|
||||
10. Push tag upstream::
|
||||
11. Push tag upstream::
|
||||
|
||||
$ git push --tags
|
||||
|
||||
11. Build and upload a test release::
|
||||
12. Build and upload a test release::
|
||||
|
||||
$ make release_test_via_docker_ubuntu
|
||||
|
||||
12. Build and upload a final release::
|
||||
13. Build and upload a final release::
|
||||
|
||||
$ make release_via_docker_ubuntu
|
||||
|
||||
@@ -2,101 +2,73 @@
|
||||
Roadmap
|
||||
=======
|
||||
|
||||
- Goals for version 2.2:
|
||||
- Workflow:
|
||||
|
||||
- Improve workflow system
|
||||
- Workflow indexing support. Accessor already works ``{{ document.workflows.all.0.get_current_state }}``. Index recalculation after workflow transition is missing.
|
||||
- Workflow actions. Predefined actions to be execute on document leaving or entering a state or a transition. Example: "Add to folder X", "Attach tag X".
|
||||
- Add support for state recipients.
|
||||
- Add workflow document inbox notification.
|
||||
|
||||
- Indexing
|
||||
|
||||
- Replace indexing and smart linking template language (use Jinja2 instead of Django's).
|
||||
- Display/find documents by their current workflow state.
|
||||
|
||||
- Goals for version 3.0:
|
||||
- Distribution:
|
||||
|
||||
- Replace UI.
|
||||
- Debian packages. Limited success so far using https://github.com/astraw/stdeb.
|
||||
|
||||
- General goals:
|
||||
- Notifications:
|
||||
|
||||
- Distribution:
|
||||
- Add support for subscribing to a document's events.
|
||||
- Add support for subscribing to a document type events.
|
||||
- Add support for subscribing specific events.
|
||||
|
||||
- Debian packages. Limited success so far using https://github.com/astraw/stdeb.
|
||||
- OCR:
|
||||
|
||||
- Downloads:
|
||||
- Add image preprocessing for OCR. Increase effectiveness of Tesseract.
|
||||
|
||||
- Transition from filetransfer package to django-downloadview. This task was started and the view ``common.generics.SingleObjectDownloadView`` was created. The ``document_signatures`` app is the first app to use it.
|
||||
- Python 3:
|
||||
|
||||
- Notifications:
|
||||
- Complete support for Python3.
|
||||
- Find replacement for pdfminer (Python3 support blocker). Use pdfminer.six (#257).
|
||||
|
||||
- Add support for subscribing to a document's events.
|
||||
- Add support for subscribing to a document type events.
|
||||
- Add support for subscribing specific events.
|
||||
- Simple serving:
|
||||
|
||||
- OCR:
|
||||
- Provide option to serve Mayan EDMS without a webserver (using Tornado o similar). Work started in branch: ``/feature/tornado``
|
||||
|
||||
- Add image preprocessing for OCR. Increase effectiveness of Tesseract.
|
||||
- Improve interface with tesseract.
|
||||
- Fix pytesseract shortcomings via upstream patches or re-implement. Move to PyOCR.
|
||||
- Upload wizard:
|
||||
|
||||
- Python 3:
|
||||
- Make wizard step configurable. Create ``WirzardStep`` class so apps can add their own upload wizard steps, instead of the steps being hardcoded in the sources app.
|
||||
- Add upload wizard step to add the new documents to a folder.
|
||||
|
||||
- Complete support for Python3.
|
||||
- Find replacement for pdfminer (Python3 support blocker). Use pdfminer.six (#257).
|
||||
- Other
|
||||
|
||||
- Simple serving:
|
||||
|
||||
- Provide option to serve Mayan EDMS without a webserver (using Tornado o similar). Work started in branch: ``/feature/tornado``
|
||||
|
||||
- Source code:
|
||||
|
||||
- Implement Developer certificate of origin: http://developercertificate.org/
|
||||
|
||||
- Upload wizard:
|
||||
|
||||
- Make wizard step configurable. Create ``WirzardStep`` class so apps can add their own upload wizard steps, instead of the steps being hardcoded in the sources app.
|
||||
- Add upload wizard step to add the new documents to a folder.
|
||||
|
||||
- Other
|
||||
|
||||
- Use a sequence and not the document upload date to determine the document version sequence. MySQL doesn't store milisecond value in dates and if several version are uploaded in a single second there is no way to know the order or which one is the latests. This is why the document version tests include a 2 second delay. Possible solution: http://schinckel.net/2015/05/17/django-second-autofield/
|
||||
- Include external app Mayan-EXIF into main code.
|
||||
- Convert all views from functions to class based views (CBV).
|
||||
- Increase test coverage.
|
||||
- Mock external services in tests. For example the ``django_GPG`` app key search and receive tests.
|
||||
- Pluggable icon app. Make switching icon set easier.
|
||||
- Reduce dependency on binary executables for a default install.
|
||||
- Find replacement for ``cssmin`` & ``django-compressor``.
|
||||
- Find replacement for ``python-gnupg``. Unstable & inconsistent API.
|
||||
- Google docs integration. Upload document from Google Drive.
|
||||
- Get ``dumpdata`` and ``loaddata`` working flawlessly. Will allow for easier backups, restores and database backend migrations.
|
||||
- Make more view asynchronous:
|
||||
|
||||
- trash can emptying.
|
||||
- document delete view.
|
||||
|
||||
- Add support for loading settings from environment variables, not just settings/local.py.
|
||||
- Add generic list ordering. ``django.views.generic.list.MultipleObjectMixin`` (https://docs.djangoproject.com/en/1.8/ref/class-based-views/mixins-multiple-object/#django.views.generic.list.MultipleObjectMixin) now supports an ``ordering`` parameter.
|
||||
- Workaround GitLab CI MySQL test errors. GitLab MySQL's container doesn't support UTF-8 content.
|
||||
- Add support for downloading the OCR content as a text file.
|
||||
- Add support to convert any document to PDF. https://gitlab.mister-muffin.de/josch/img2pdf
|
||||
- Add support for combining documents.
|
||||
- Add support for splitting documents.
|
||||
- Add task viewer.
|
||||
- Add new document source to get documents from an URL.
|
||||
- Document overlay support. Such as watermarks. https://gist.github.com/umrashrf/8616550
|
||||
- Add support for metadata mapping files. CSV file containing filename to metadata values mapping, useful for bulk upload and migrations.
|
||||
- Add support for registering widgets to the home screen.
|
||||
- Merge mimetype and converter apps.
|
||||
- Add entry in About menu to check latest Mayan EDMS version via PyPI.
|
||||
- Add GPG key generation.
|
||||
- Add documentation section on editing the settings/local.py file.
|
||||
- Add documentation section with warning about using runserver.
|
||||
- Replace ``urlpatterns = patterns( ''``, with Python lists. Django recommendation for post 1.7.
|
||||
- If SourceColumn label is None take description from model. Avoid unnecessary translatable strings.
|
||||
- Metadata widgets (Date, time, timedate).
|
||||
- Datatime widget: https://github.com/smalot/bootstrap-datetimepicker
|
||||
- Separate Event class instances with a parent namespace class: EventNamespace.
|
||||
- Add events for document signing app (uploaded detached signateure, signed document, deleted signature)
|
||||
- A configurable conversion process. Being able to invoke different binaries for file conversion, as opposed to the current libreoffice only solution.
|
||||
- A tool in the admin interface to mass (re)convert the files (basically the page count function, but then applied on all documents).
|
||||
- Find solution so that documents in watched folders are not processed until they are ready. Use case scanning directly to scanned folders.
|
||||
- Use a sequence and not the document upload date to determine the document version sequence. MySQL doesn't store milisecond value in dates and if several version are uploaded in a single second there is no way to know the order or which one is the latests. This is why the document version tests include a 2 second delay. Possible solution: http://schinckel.net/2015/05/17/django-second-autofield/
|
||||
- Include external app Mayan-EXIF into main code.
|
||||
- Convert all views from functions to class based views (CBV).
|
||||
- Increase test coverage.
|
||||
- Mock external services in tests. For example the ``django_GPG`` app key search and receive tests.
|
||||
- Pluggable icon app. Make switching icon set easier.
|
||||
- Reduce dependency on binary executables for a default install.
|
||||
- Find replacement for ``cssmin`` & ``django-compressor``.
|
||||
- Find replacement for ``python-gnupg``. Unstable & inconsistent API.
|
||||
- Google docs integration. Upload document from Google Drive.
|
||||
- Get ``dumpdata`` and ``loaddata`` working flawlessly. Will allow for easier backups, restores and database backend migrations.
|
||||
- Add generic list ordering. ``django.views.generic.list.MultipleObjectMixin`` (https://docs.djangoproject.com/en/1.8/ref/class-based-views/mixins-multiple-object/#django.views.generic.list.MultipleObjectMixin) now supports an ``ordering`` parameter.
|
||||
- Add support to convert any document to PDF. https://gitlab.mister-muffin.de/josch/img2pdf
|
||||
- Add support for combining documents.
|
||||
- Add support for splitting documents.
|
||||
- Add new document source to get documents from an URL.
|
||||
- Document overlay support. Such as watermarks. https://gist.github.com/umrashrf/8616550
|
||||
- Add support for metadata mapping files. CSV file containing filename to metadata values mapping, useful for bulk upload and migrations.
|
||||
- Add support for registering widgets to the home screen.
|
||||
- Merge mimetype and converter apps.
|
||||
- Add GPG key generation.
|
||||
- If SourceColumn label is None take description from model. Avoid unnecessary translatable strings.
|
||||
- Metadata widgets (Date, time, timedate).
|
||||
- Datatime widget: https://github.com/smalot/bootstrap-datetimepicker
|
||||
- Separate Event class instances with a parent namespace class: EventNamespace.
|
||||
- Add events for document signing app (uploaded detached signateure, signed document, deleted signature)
|
||||
- A configurable conversion process. Being able to invoke different binaries for file conversion, as opposed to the current libreoffice only solution.
|
||||
- A tool in the admin interface to mass (re)convert the files (basically the page count function, but then applied on all documents).
|
||||
- Find solution so that documents in watched folders are not processed until they are ready. Use case scanning directly to scanned folders.
|
||||
|
||||
Reference in New Issue
Block a user