Update documentation. Add chapter on password resets. Add administration topic.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>

docs/chapters/languages.rst

@@ -30,7 +30,7 @@ Example::
   -e MAYAN_DOCUMENTS_LANGUAGE_CODES='["eng", "spa"]'
 
 For more information check out the
-:ref:`environment variables <environment_variables>` section of the
+:ref:`environment variables <environment_variables>` chapter of the
-:doc:`../chapters/settings` chapter.
+:doc:`../topics/settings` topic.
 
 

docs/chapters/mailing.rst

@@ -1,31 +1,14 @@
+.. _mailing:
+
 *****************
 Mailing documents
 *****************
 
 Sending emails in Mayan EDMS is controlled by two different system depending on
 the type of email being sent. These are administrative emails like password
-reset emails and user emails sent from the application.
+reset emails and user emails sent from the application. To configure
-
+administrative email for things like password reset check the topic:
-Sending administrative emails
+:doc:`../topics/administration`
-=============================
-
-To be able to send password reset emails configure the Django email settings
-via the :ref:`configuration file <configuration_file>`.
-
-Example::
-
-    EMAIL_BACKEND: django.core.mail.backends.smtp.EmailBackend
-    EMAIL_HOST: '<your smtp ip address or hostname>'
-    EMAIL_HOST_PASSWORD: '<your smtp password>'
-    EMAIL_HOST_USER: '<your smtp username>'
-    EMAIL_PORT: 25  # or 587 or your server's SMTP port
-    EMAIL_TIMEOUT:
-    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
-
 
 Application emails
 ==================
@@ -35,3 +18,7 @@ Mayan EDMS provides its our own email system called Mailing Profiles.
 Mailing Profiles support access control per user role and can use different
 email backends. Mailing Profiles are created from the
 :menuselection:`System --> Setup` menu.
+
+Once created mailing profiles allow users to send email messages from
+within the user interafce containing either an URL link to the document or
+the actual document as an attachment.

docs/chapters/ocr_backend.rst

@@ -18,4 +18,9 @@ To add support to OCR more languages when using Tesseract, install the
 corresponding language file. If using a Debian based OS, this command will
 display the available language files:
 
-   apt-cache search tesseract-ocr
+    apt-cache search tesseract-ocr
+
+If using the Docker image, pass the environment variable MAYAN_APT_INSTALLS
+with the corresponding Tesseract language option. Example::
+
+    -e MAYAN_APT_INSTALLS='tesseract-ocr-deu'

docs/chapters/password_reset.rst

@@ -0,0 +1,41 @@
+**************
+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>`.
+
+Sending administrative emails
+=============================
+
+To be able to send password reset emails configure the Django email settings
+via the :ref:`configuration file <configuration_file>`.
+
+Example::
+
+    EMAIL_BACKEND: django.core.mail.backends.smtp.EmailBackend
+    EMAIL_HOST: '<your smtp ip address or hostname>'
+    EMAIL_HOST_PASSWORD: '<your smtp password>'
+    EMAIL_HOST_USER: '<your smtp username>'
+    EMAIL_PORT: 25  # or 587 or your server's SMTP port
+    EMAIL_TIMEOUT:
+    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
+:doc:`../topics/settings` topic.
+
+To test the email settings use the management command ``sendtestemail``.
+Example::
+
+    mayan-edms.py sendtestemail myself@example.com
+
+
+

docs/chapters/settings.rst

@@ -1,3 +1,7 @@
+********
+Settings
+********
+
 
 Mayan EDMS can be configure via environment variables or by setting files.
 

docs/index.rst

@@ -17,23 +17,23 @@ repository for electronic documents.
 .. toctree::
     :hidden:
 
-    Features <topics/features>
+    topics/features
-    Installation <topics/installation>
+    topics/installation
-    Release notes and upgrading <releases/index>
+    releases/index
-    Getting started <topics/getting_started>
+    topics/getting_started
-    Access control <topics/access_control>
+    topics/access_control
-    Categorization <topics/categorization>
+    topics/categorization
-    Collaboration <topics/collaboration>
+    topics/collaboration
-    Settings <topics/settings>
+    topics/settings
-    Storage <topics/storage>
+    topics/storage
-    Integration <topics/integration>
+    topics/integration
-    Maintenance <topics/maintenance>
+    topics/maintenance
-    Advanced topics <topics/advanced>
+    topics/administration
-    Development <topics/development>
+    topics/advanced
-    FAQ <topics/faq>
+    topics/development
-    Licensing <topics/license>
+    topics/faq
-    Contact <topics/contact>
+    topics/license
-
+    topics/contact
 
 .. _Docker: https://www.docker.com/
 .. _Django: http://www.djangoproject.com/

docs/releases/index.rst

@@ -1,6 +1,6 @@
-#############
+###########################
-Release notes
+Release notes and upgrading
-#############
+###########################
 
 Release notes for the official Mayan EDMS releases. Each release note will tell you
 what's new in each version, and will also describe any backwards-incompatible

docs/topics/administration.rst

@@ -0,0 +1,9 @@
+##############
+Administration
+##############
+
+
+.. include:: ../chapters/languages.rst
+.. include:: ../chapters/password_reset.rst
+.. include:: ../chapters/ocr_backend.rst
+.. include:: ../chapters/scaling_up.rst

docs/topics/advanced.rst

@@ -4,10 +4,7 @@ Advanced topics
 
 
 .. include:: ../chapters/workflows.rst
-.. include:: ../chapters/languages.rst
 .. include:: ../chapters/signatures.rst
 .. include:: ../chapters/metadata.rst
-.. include:: ../chapters/ocr_backend.rst
 .. include:: ../chapters/transformations.rst
 .. include:: ../chapters/versioning.rst
-.. include:: ../chapters/scaling_up.rst

docs/topics/development.rst

@@ -1,7 +1,6 @@
-###############
+##############
-Advanced topics
+For developers
-###############
+##############
-
 
 .. include:: ../chapters/development.rst
 .. include:: ../chapters/app_creation.rst

docs/topics/maintenance.rst

@@ -4,3 +4,4 @@ Maintenance
 
 
 .. include:: ../chapters/backups.rst
+

docs/topics/settings.rst

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