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

Update release notes. Fix typos is older documentation format.

Browse Source 
Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2018-10-04 19:06:18 -04:00
parent b6fbce16c0
commit e9180f68d7
5 changed files with 83 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/releases/1.1.rst
View File

@@ -240,7 +240,7 @@ Migrate existing database schema with::
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:

2
docs/releases/2.0.rst
View File

@@ -406,7 +406,7 @@ Migrate existing database schema with::
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:

52
docs/releases/3.1.4.rst
View File

@@ -2,8 +2,50 @@
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.
Thanks to Matthias Urlichs @smurfix for the report.
* Update related links. Add links to the new Wiki and Forum.
@@ -15,12 +57,10 @@ Released: October XX, 2018
in the trash.
* Load the DropZone CSS from package and remove the
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.
Closes GitLab issue #517. Thanks to Daniel Carrico @daniel1113
for the report.
* Add explanation to the launch workflows tool.
Removals
--------
@@ -40,7 +80,7 @@ Remove deprecated requirements::
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.
@@ -81,7 +121,7 @@ The upgrade procedure is now complete.
Backward incompatible changes
=============================
-----------------------------
* None

3
docs/releases/3.1.rst
View File

@@ -61,7 +61,8 @@ Example::
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]
To change the default width of thumbnails, navigate to [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

27
docs/topics/development.rst
View File

@@ -421,38 +421,47 @@ or with::
8. Bump version in `mayan/__init__.py`.
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
11. Build source package and test::
11. Build source package and test:
::
make test-sdist-via-docker-ubuntu
12. Build wheel package and test::
12. Build wheel package and test:
::
make test-wheel-via-docker-ubuntu
13. Tag version::
13. Tag version:
::
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
15. Push tag upstream::
15. Push tag upstream:
::
git push --tags
16. Push code to trigger builds::
16. Push code to trigger builds:
::
git push
17. Build and upload a test release::
17. Build and upload a test release:
::
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