Merge remote-tracking branch 'origin/versions/micro' into feature/merge_with_micro

Signed-off-by: Roberto Rosario <roberto.rosario@mayan-edms.com>

docs/chapters/development.rst

@@ -226,32 +226,46 @@ Git branch structure
 Mayan EDMS follows a simplified model layout based on Vincent Driessen's
 `Successful Git Branching Model`_ blog post.
 
-``development``
-    The "next release" branch, likely unstable, don't use in production.
+``/versions/micro``
+    Working branch for the next bugfix release. Micro increment (third digit).
+    Only bug fixes, minor features, back-ported urgent features. This
+    branch is stable and safe for production.
+``/versions/minor``
+    Working branch for the next minor release (second digit). New features,
+    occasional breakage. Not for production but should run in test
+    environment most of the time. This is the branch you will want to
+    try out if you want to check out new features.
+``/versions/major``
+    Working branch for the next major release (first digit). New features,
+    incompatible changes to the user facing interfaces. Broken most of the
+    time, not for production and should only be cloned by developers
+    with experience with Mayan's development.
 ``master``
     Current production release (|version|). Points to the latest version of
     the latest series. Production quality code.
-``feature/``
-    Unfinished/unmerged feature. Likely unstable, don't use in production.
-
+``features/``
+    Working branches for unfinished and unmerged feature. Likely unstable,
+    don't use in production. Once the feature is complete, it is merged
+    into one of the versions branches and deleted.
+    
 Special branches:
 
 ``releases/all``
-    Used by the continuous delivery system to trigger the build and release
+    Pushing code to this branch will trigger the build and release
     a new Docker image, Documentation and Python package.
 ``releases/docker``
-    Used by the continuous delivery system to trigger the build and release
+    Pushing code to this branch will trigger the build and release
     of a new Docker image to Docker Hub.
 ``releases/documentation``
-    Used by the continuous delivery system to trigger the build and release
+    Pushing code to this branch will trigger the build and release
     of new documentation.
 ``releases/python``
-    Used by the continuous delivery system to trigger the build and release
+    Pushing code to this branch will trigger the build and release
     of a new Python package to PyPI.
 ``nightly``
-    Used by the continuous delivery system to trigger the build and release
+    Pushing code to this branch will trigger the build and release
     of a new Docker image based on development code to the GitLab image
-    repository.
+    repository only. The image will not be published to Docker Hub.
 
 Each release is tagged separately using annotated Git tags.
 
@@ -519,7 +533,7 @@ Release using GitLab CI
    ::
 
        git checkout releases/all
-       git merge versions/next
+       git merge <corresponding branch>
 
 #. Push code to trigger builds:
    ::

docs/chapters/docker.rst

@@ -135,6 +135,13 @@ image specific environment variables are available.
 
 Optional. Allows loading an alternate settings file.
 
+
+``MAYAN_GUNICORN_TIMEOUT``
+
+Optional. Changes the amount of time the frontend worker will wait for a
+request to finish before raising a timeout error. The default is 120
+seconds.
+
 ``MAYAN_GUNICORN_WORKERS``
 
 Optional. This environment variable controls the number of frontend workers

docs/conf.py

@@ -22,7 +22,9 @@ import mayan
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
+sys.path.append(
+    os.path.abspath(os.path.join(os.path.dirname(__file__), '_ext'))
+)
 
 # -- General configuration -----------------------------------------------------
 
@@ -34,12 +36,13 @@ sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))
 #extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 #extensions = ["djangodocs", "sphinx.ext.intersphinx"]
 extensions = [
-    'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag', 'sphinxcontrib.spelling'
+    'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag',
+    'sphinxcontrib.spelling'
 ]
 
 blockdiag_antialias = True
-blockdiag_html_image_format = "SVG"
-blockdiag_latex_image_format = "PDF"
+blockdiag_html_image_format = 'SVG'
+blockdiag_latex_image_format = 'PDF'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -106,12 +109,14 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {
+    'analytics_id': 'UA-52965619-6',
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -139,7 +144,7 @@ html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -162,7 +167,7 @@ html_static_path = ['_static']
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 #html_show_sphinx = True
@@ -181,8 +186,6 @@ html_static_path = ['_static']
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'MayanEDMSdoc'
 
-html_show_sourcelink = False
-
 html_show_sphinx = False
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -233,8 +236,6 @@ man_pages = [
      [mayan.__author__], 1)
 ]
 
-html_theme = 'sphinx_rtd_theme'
-
 # -- External links --
 extlinks = {
     'django-docs': (
@@ -253,5 +254,6 @@ extlinks = {
     )
 }
 
+
 def setup(app):
     app.add_stylesheet('css/custom.css')

docs/releases/3.2.8.rst

@@ -0,0 +1,161 @@
+Version 3.2.8
+=============
+
+Released: October 1, 2019
+
+
+Changes
+-------
+
+
+API
+^^^
+
+Fix an error when accessing some API entry points without
+being authenticated. Accessing API endpoints without being authenticated
+will now always return empty results.
+
+
+Cabinets
+^^^^^^^^
+
+Tweaked the jstree component's appearance to cope with long labels.
+Added a scrollbar, reduced the font size, switched to a sans serif font,
+and reduced padding. Thanks for forum user @briboe for the report.
+
+Workflow actions to add and remove documents from cabinets was added.
+
+
+Dependencies
+^^^^^^^^^^^^
+
+The Django version used was updated to version 1.11.24. The jQuery version
+used was updated to version 3.4.1. Both as fully backwards compatible with
+their previous versions.
+
+
+OCR
+^^^
+
+Support was added to delete the content of document's OCR or parsed content.
+Events for both situations was added allowing content deletion to be used
+as workflow transition triggers.
+
+
+Docker
+^^^^^^
+
+A missing recursive option was added to the Docker entrypoint
+command "chown" to change the ownership of files when specifying a custom
+UID or GID. Closes GitLab issue #668. Thanks to John Wice (@brilthor)
+for the report.
+
+Two fonts were added to the Docker image to support rendering Chinese office
+documents. Closes GitLab issue #666. Thanks to javawcy (@javawcy) and forum
+user @leoliu for the report and help closing this issue.
+
+
+Usability
+^^^^^^^^^
+
+Descriptions for screenreaders was added via image alt tag. The user interface
+will also now allow scaling.
+
+
+Removals
+--------
+
+- None
+
+
+Upgrading from a previous version
+---------------------------------
+
+If installed via Python's PIP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Remove deprecated requirements::
+
+    sudo -u mayan curl https://gitlab.com/mayan-edms/mayan-edms/raw/master/removals.txt -o /tmp/removals.txt && sudo -u mayan /opt/mayan-edms/bin/pip uninstall -y -r /tmp/removals.txt
+
+Type in the console::
+
+    sudo -u mayan /opt/mayan-edms/bin/pip install mayan-edms==3.2.8
+
+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.
+
+Remove deprecated requirements::
+
+    $ pip uninstall -y -r removals.txt
+
+Next upgrade/add the new requirements::
+
+    $ pip install --upgrade -r requirements.txt
+
+
+Common steps
+^^^^^^^^^^^^
+
+Perform these steps after updating the code from either step above.
+
+Make a backup of your supervisord file::
+
+    sudo cp /etc/supervisor/conf.d/mayan.conf /etc/supervisor/conf.d/mayan.conf.bck
+
+Update the supervisord configuration file. Replace the environment
+variables values show here with your respective settings. This step will refresh
+the supervisord configuration file with the new queues and the latest
+recommended layout::
+
+    sudo 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 platformtemplate supervisord > /etc/supervisor/conf.d/mayan.conf
+
+Edit the supervisord configuration file and update any setting the template
+generator missed::
+
+    sudo vi /etc/supervisor/conf.d/mayan.conf
+
+Migrate existing database schema with::
+
+    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 performupgrade
+
+Add new static media::
+
+    sudo -u mayan MAYAN_MEDIA_ROOT=/opt/mayan-edms/media \
+    /opt/mayan-edms/bin/mayan-edms.py preparestatic --noinput
+
+The upgrade procedure is now complete.
+
+
+Backward incompatible changes
+-----------------------------
+
+- None
+
+
+Bugs fixed or issues closed
+---------------------------
+
+- :gitlab-issue:`666` Chinese document such as .doc can't display well.
+- :gitlab-issue:`668` Permission denied errors with custom uid persist (650 needs re-open)
+- :forum-topic:`1120` Cabinet Presentation
+- :forum-topic:`2202` Cannot display Chinese character and cannot identify Excel files
+
+.. _PyPI: https://pypi.python.org/pypi/mayan-edms/

docs/releases/index.rst

@@ -21,6 +21,7 @@ versions of the documentation contain the release notes for any later releases.
    :maxdepth: 1
 
    3.3
+   3.2.8
    3.2.7
    3.2.6
    3.2.5