Update documentation

Fix typos, expand and update FAQ.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2019-06-13 02:20:44 -04:00
parent 9836ca3ef3
commit 4d52dbde39
12 changed files with 139 additions and 66 deletions

View File

@@ -12,7 +12,7 @@ does.
Compilers and development libraries will be installed to compile runtime
libraries. LibreOffice and Poppler utils will also be installed as they are
used to convert document files. Supervisor (http://supervisord.org/), a
used to convert document files. Supervisor (https://supervisord.org/), a
Process Control System, will be used to monitor and keep all Mayan processes
running.
@@ -43,7 +43,7 @@ For another setup that offers more performance and scalability refer to the
2. Create the user account for the installation:
------------------------------------------------
This will create an unpriviledge user account that is also unable to login.
This will create an unprivileged user account that is also unable to login.
::
sudo adduser mayan --disabled-password --disabled-login --no-create-home --gecos ""
@@ -61,7 +61,7 @@ For another setup that offers more performance and scalability refer to the
4. Create the Python virtual environment:
-----------------------------------------
This will keep all the Python packages installed here isolated from the rest
of the Pythoon packages in the system.
of the Python packages in the system.
::
sudo virtualenv /opt/mayan-edms
@@ -113,9 +113,9 @@ For another setup that offers more performance and scalability refer to the
For simplicity, the ``MAYAN_MEDIA_ROOT`` folder is set to be a subfolder
of the installation. If you want to keep your files separated from
the installation files, change the value of the ``MAYAN_MEDIR_ROOT``
the installation files, change the value of the ``MAYAN_MEDIA_ROOT``
variable in this and all subsequent steps. Be sure to first create the
folder and give owership of it to the ``mayan`` user with the ``chown``
folder and give ownership of it to the ``mayan`` user with the ``chown``
command.
.. warning::
@@ -157,7 +157,7 @@ For another setup that offers more performance and scalability refer to the
12. Configure Redis:
--------------------
Configure Redit to discard data when it runs out of memory, not save its
Configure Redis to discard data when it runs out of memory, not save its
database and only keep 1 database:
::

View File

@@ -297,7 +297,7 @@ The command line would look like this::
Now create a watch folder in Mayan EDMS using the path ``/scanned_files``
and the documents from the host folder ``/opt/scanned_files`` will be
automatically available. Use the same procedure to mount host folders to be
used as staging folderes. In this example ``/scanned_files`` was used as the
used as staging folders. In this example ``/scanned_files`` was used as the
container directory, but any path can be used as long as:
- the path not an already existing path
@@ -379,7 +379,7 @@ Execute Docker's build command using the provided makefile::
make docker-build
Or using an apt cacher to speed up the build::
Or using an APT cache to speed up the build::
make docker-build-with-proxy APT_PROXY=172.17.0.1:3142

View File

@@ -111,8 +111,8 @@ Index documents not found in any cabinet
{% if document.cabinets.count == 0 %}No Cabinets{% endif %}
Index untagged documents
^^^^^^^^^^^^^^^^^^^^^^^^
Index documents not tagged
^^^^^^^^^^^^^^^^^^^^^^^^^^
::
{% if document.tags.count == 0 %}No Tags{% endif %}

View File

@@ -74,6 +74,6 @@ Creating new sources
#. Go to the :menuselection:`System --> Setup --> Sources` menu.
#. From the :guilabel:`Actions` dropdown select the new type of source to create.
#. Each source type will have different fields to customize its behaviour. Enter
#. Each source type will have different fields to customize its behavior. Enter
the required information in each field based on the help text provided.
#. Press :guilabel:`Save`.

View File

@@ -76,5 +76,5 @@ Uploading a new document version
#. From the :guilabel:`Actions` dropdown select :guilabel:`Upload new version`.
#. Optionally type a comment explaining the changes in the new version.
#. Press the :guilabel:`Browse` button and select a new file.
#. Press :guilabel:`Save` upload the new verision.
#. Press :guilabel:`Save` upload the new version.