Update release notes. Fix typos is older documentation format.
Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
@@ -240,7 +240,7 @@ Migrate existing database schema with::
|
|||||||
|
|
||||||
During the migration several messages of stale content types can occur:
|
During the migration several messages of stale content types can occur:
|
||||||
|
|
||||||
.. code-block:: bash
|
::
|
||||||
|
|
||||||
The following content types are stale and need to be deleted:
|
The following content types are stale and need to be deleted:
|
||||||
|
|
||||||
|
|||||||
@@ -406,7 +406,7 @@ Migrate existing database schema with::
|
|||||||
|
|
||||||
During the migration several messages of stale content types can occur:
|
During the migration several messages of stale content types can occur:
|
||||||
|
|
||||||
.. code-block:: bash
|
::
|
||||||
|
|
||||||
The following content types are stale and need to be deleted:
|
The following content types are stale and need to be deleted:
|
||||||
|
|
||||||
|
|||||||
@@ -2,8 +2,50 @@
|
|||||||
Mayan EDMS v3.1.4 release notes
|
Mayan EDMS v3.1.4 release notes
|
||||||
===============================
|
===============================
|
||||||
|
|
||||||
Released: October XX, 2018
|
Released: October 4, 2018
|
||||||
|
|
||||||
|
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
|
||||||
|
logic has been revised to work on terms first for each
|
||||||
|
field and then the results are merged. This change improves
|
||||||
|
the results of the search system at the expense of some speed.
|
||||||
|
|
||||||
|
The search system also worked by default in 'AND' mode.
|
||||||
|
This meant that all terms had to be found in a field for the
|
||||||
|
result to count. User were adding the word 'AND' in the
|
||||||
|
searches and this cause the search system to look for the
|
||||||
|
word 'AND' and when not finding would affect the search results.
|
||||||
|
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
|
||||||
|
index when the OCR is ready.
|
||||||
|
|
||||||
|
Another custom signal similar to the OCR completion one was
|
||||||
|
added to the document parsing app. This allows the index app
|
||||||
|
to also refresh the indexes when the parsing of document
|
||||||
|
text is finished.
|
||||||
|
|
||||||
|
This example indexes documents if they have the fragment
|
||||||
|
"quarterly report" in the OCR text::
|
||||||
|
|
||||||
|
{% if "quarterly report" document.latest_version.ocr_content|join:" "|lower %}Quarterly reports{% endif %} {# Detect the word "quarterly report" in the document OCR text #}
|
||||||
|
|
||||||
|
The same applies to text content extracted for the document::
|
||||||
|
|
||||||
|
{% if "quarterly report" document.latest_version.content|join:" "|lower %}Quarterly reports{% endif %} {# Detect the word "quarterly report" in the document text #}
|
||||||
|
|
||||||
|
|
||||||
|
Other changes
|
||||||
|
~~~~~~~~~~~~~
|
||||||
* Fix the link to the documenation. Closes GitLab issue #516.
|
* Fix the link to the documenation. Closes GitLab issue #516.
|
||||||
Thanks to Matthias Urlichs @smurfix for the report.
|
Thanks to Matthias Urlichs @smurfix for the report.
|
||||||
* Update related links. Add links to the new Wiki and Forum.
|
* Update related links. Add links to the new Wiki and Forum.
|
||||||
@@ -15,12 +57,10 @@ Released: October XX, 2018
|
|||||||
in the trash.
|
in the trash.
|
||||||
* Load the DropZone CSS from package and remove the
|
* Load the DropZone CSS from package and remove the
|
||||||
hard code CSS from appearance/base.css.
|
hard code CSS from appearance/base.css.
|
||||||
* Add support for indexing on OCR content changes.
|
|
||||||
* Add support for reindexing document on content parsing
|
|
||||||
changes.
|
|
||||||
* Strip HTML entities from the browser's window title.
|
* Strip HTML entities from the browser's window title.
|
||||||
Closes GitLab issue #517. Thanks to Daniel Carrico @daniel1113
|
Closes GitLab issue #517. Thanks to Daniel Carrico @daniel1113
|
||||||
for the report.
|
for the report.
|
||||||
|
* Add explanation to the launch workflows tool.
|
||||||
|
|
||||||
Removals
|
Removals
|
||||||
--------
|
--------
|
||||||
@@ -40,7 +80,7 @@ Remove deprecated requirements::
|
|||||||
|
|
||||||
Type in the console::
|
Type in the console::
|
||||||
|
|
||||||
$ pip install mayan-edms==3.1.3
|
$ pip install mayan-edms==3.1.4
|
||||||
|
|
||||||
the requirements will also be updated automatically.
|
the requirements will also be updated automatically.
|
||||||
|
|
||||||
@@ -81,7 +121,7 @@ The upgrade procedure is now complete.
|
|||||||
|
|
||||||
|
|
||||||
Backward incompatible changes
|
Backward incompatible changes
|
||||||
=============================
|
-----------------------------
|
||||||
|
|
||||||
* None
|
* None
|
||||||
|
|
||||||
|
|||||||
@@ -61,11 +61,12 @@ Example::
|
|||||||
The second feature allow users to make changes to the settings options from the
|
The second feature allow users to make changes to the settings options from the
|
||||||
web interface. Just navigate to [System] -> [Setup] -> [Settings]. Settings are
|
web interface. Just navigate to [System] -> [Setup] -> [Settings]. Settings are
|
||||||
grouped by namespaces based on the app of type of system their control.
|
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]
|
To change the default width of thumbnails, navigate to [Documents] ->
|
||||||
and click on [Edit] to change the current value. Upon clicking on [Save] the
|
[DOCUMENTS_THUMBNAIL_WIDTH]
|
||||||
``config.yml`` will be updated to include this new value. A restart of the installation
|
and click on [Edit] to change the current value. Upon clicking on [Save] the
|
||||||
is required to make the change effective. This is not a Mayan limitation but a
|
``config.yml`` will be updated to include this new value. A restart of the installation
|
||||||
design decision of Django, the framework upon which Mayan is built.
|
is required to make the change effective. This is not a Mayan limitation but a
|
||||||
|
design decision of Django, the framework upon which Mayan is built.
|
||||||
|
|
||||||
The third feature creates a backup configuration file every time the installation
|
The third feature creates a backup configuration file every time the installation
|
||||||
of Mayan successfully starts. This keeps one backup of the last configuration
|
of Mayan successfully starts. This keeps one backup of the last configuration
|
||||||
@@ -365,7 +366,7 @@ Other changes
|
|||||||
- Improve the speed of the document indexing.
|
- Improve the speed of the document indexing.
|
||||||
- Move the matchHeight call from lazy loading to image loading.
|
- Move the matchHeight call from lazy loading to image loading.
|
||||||
Reduces the chance of wrongly sized cards.
|
Reduces the chance of wrongly sized cards.
|
||||||
- Generalize the Javascript menu rendering into an API for
|
- Generalize the Javascript menu rendering into an API for
|
||||||
templates that only refresh the menu when there are changes.
|
templates that only refresh the menu when there are changes.
|
||||||
Closes GitLab issue #511. Thanks to Daniel Carrico
|
Closes GitLab issue #511. Thanks to Daniel Carrico
|
||||||
@daniel1113 for the report.
|
@daniel1113 for the report.
|
||||||
@@ -463,5 +464,5 @@ Bugs fixed or issues closed
|
|||||||
* `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 #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 #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 #511 <https://gitlab.com/mayan-edms/mayan-edms/issues/511>`_ Menu bar flickering in 3.1b1
|
||||||
|
|
||||||
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
|
||||||
|
|||||||
@@ -421,38 +421,47 @@ or with::
|
|||||||
|
|
||||||
8. Bump version in `mayan/__init__.py`.
|
8. Bump version in `mayan/__init__.py`.
|
||||||
9. Bump version in `docker/version`.
|
9. Bump version in `docker/version`.
|
||||||
10. Update requirements version in `setup.py` using::
|
10. Update requirements version in `setup.py` using:
|
||||||
|
::
|
||||||
|
|
||||||
make generate-setup
|
make generate-setup
|
||||||
|
|
||||||
11. Build source package and test::
|
11. Build source package and test:
|
||||||
|
::
|
||||||
|
|
||||||
make test-sdist-via-docker-ubuntu
|
make test-sdist-via-docker-ubuntu
|
||||||
|
|
||||||
12. Build wheel package and test::
|
12. Build wheel package and test:
|
||||||
|
::
|
||||||
|
|
||||||
make test-wheel-via-docker-ubuntu
|
make test-wheel-via-docker-ubuntu
|
||||||
|
|
||||||
13. Tag version::
|
13. Tag version:
|
||||||
|
::
|
||||||
|
|
||||||
git tag -a vX.Y.Z -m "Version X.Y.Z"
|
git tag -a vX.Y.Z -m "Version X.Y.Z"
|
||||||
|
|
||||||
14. Switch to the `releases` branch::
|
14. Switch to the `releases` branch:
|
||||||
|
::
|
||||||
|
|
||||||
git checkout releases
|
git checkout releases
|
||||||
|
|
||||||
15. Push tag upstream::
|
15. Push tag upstream:
|
||||||
|
::
|
||||||
|
|
||||||
git push --tags
|
git push --tags
|
||||||
|
|
||||||
16. Push code to trigger builds::
|
16. Push code to trigger builds:
|
||||||
|
::
|
||||||
|
|
||||||
git push
|
git push
|
||||||
|
|
||||||
17. Build and upload a test release::
|
17. Build and upload a test release:
|
||||||
|
::
|
||||||
|
|
||||||
make release-test-via-docker-ubuntu
|
make release-test-via-docker-ubuntu
|
||||||
|
|
||||||
18. Build and upload a final release::
|
18. Build and upload a final release:
|
||||||
|
::
|
||||||
|
|
||||||
make release-via-docker-ubuntu
|
make release-via-docker-ubuntu
|
||||||
|
|||||||
Reference in New Issue
Block a user