Documenation: Fix spelling errors
Fix spelling errors in documentation and other program texts. Update the spelling exceptions list. Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
@@ -65,6 +65,6 @@ Example::
|
||||
|
||||
More information at:
|
||||
|
||||
- Postgresl: http://www.postgresql.org/docs/current/static/backup.html
|
||||
- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
|
||||
- MySQL: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html
|
||||
- SQLite: Just copy the file ``mayan/media/db.sqlite3``
|
||||
|
||||
@@ -27,7 +27,7 @@ Legal Entity or (iii) beneficial ownership of such entity.
|
||||
"Contribution" means any work of authorship that is Submitted by You to Us in
|
||||
which You own or assert ownership of the Copyright. We cannot accept
|
||||
contributions for which you do not own the Copyright or for which you don't
|
||||
have the necesary legal power to transfer.
|
||||
have the necessary legal power to transfer.
|
||||
|
||||
"Copyright" means all rights protecting works of authorship owned or controlled
|
||||
by You or Your Affiliates, including copyright, moral and neighboring rights,
|
||||
|
||||
@@ -19,7 +19,7 @@ software project managed by Us.
|
||||
"Contribution" means any work of authorship that is Submitted by You to Us
|
||||
in which You own or assert ownership of the Copyright. We cannot accept
|
||||
contributions for which you do not own the Copyright or for which you don't
|
||||
have the necesary legal power to transfer.
|
||||
have the necessary legal power to transfer.
|
||||
|
||||
"Copyright" means all rights protecting works of authorship owned or
|
||||
controlled by You, including copyright, moral and neighboring rights,
|
||||
|
||||
@@ -347,9 +347,9 @@ Enable and restart the services [1_]:
|
||||
|
||||
[1]: https://bugs.launchpad.net/ubuntu/+source/supervisor/+bug/1594740
|
||||
|
||||
.. _Debian: http://www.debian.org/
|
||||
.. _Django: http://www.djangoproject.com/
|
||||
.. _Python: http://www.python.org/
|
||||
.. _Debian: https://www.debian.org/
|
||||
.. _Django: https://www.djangoproject.com/
|
||||
.. _Python: https://www.python.org/
|
||||
.. _SQLite: https://www.sqlite.org/
|
||||
.. _Ubuntu: http://www.ubuntu.com/
|
||||
.. _virtualenv: http://www.virtualenv.org/en/latest/index.html
|
||||
|
||||
@@ -188,8 +188,8 @@ Double quote is used for multiple line comments or HTML markup.
|
||||
Migrations
|
||||
----------
|
||||
|
||||
Migrations should do only one thing (eg: either create a table, move data to a
|
||||
new table or remove an old table) to aid retrying on failure.
|
||||
Migrations should do only one thing (example: either create a table, move data
|
||||
to a new table or remove an old table) to aid retrying on failure.
|
||||
|
||||
|
||||
General
|
||||
@@ -256,7 +256,7 @@ Special branches:
|
||||
of a new Docker image based on development code to the GitLab image
|
||||
repository.
|
||||
|
||||
Each release is tagged separately using annotaded Git tags.
|
||||
Each release is tagged separately using annotated Git tags.
|
||||
|
||||
When submitting patches, please place your code in its own ``feature/`` branch
|
||||
prior to opening a Merge Request on GitLab_.
|
||||
|
||||
@@ -55,7 +55,7 @@ identifier::
|
||||
|
||||
The Mayan EDMS container will connect to the PostgreSQL container via the
|
||||
``172.17.0.1`` IP address (the Docker host's default IP address). It will
|
||||
connect using the ``django.db.backends.postgresql`` database drivern and
|
||||
connect using the ``django.db.backends.postgresql`` database driver and
|
||||
connect to the ``mayan`` database using the ``mayan`` user with the password
|
||||
``mayanuserpass``. The container will keep connections to the database
|
||||
for up to 60 seconds in an attempt to reuse them increasing response time
|
||||
@@ -409,7 +409,7 @@ These are:
|
||||
|
||||
Nightly images
|
||||
==============
|
||||
The continious integration pipeline used for testing development builds also
|
||||
The continuous integration pipeline used for testing development builds also
|
||||
produces a resulting Docker image. These are build automatically and their
|
||||
stability is not guaranteed. They should never be used in production.
|
||||
If you want to try out the Docker images the development uses or want a sneak
|
||||
|
||||
@@ -23,7 +23,7 @@ links to the document of each respective type.
|
||||
#. Go to :menuselection:`Document types` and associate this index with
|
||||
existing document types in the system.
|
||||
#. Finally go to :menuselection:`Tools --> Rebuild indexes` to execute the
|
||||
index template. The rebuild process is only necesary when changes are
|
||||
index template. The rebuild process is only necessary when changes are
|
||||
made to the index templates. Otherwise they update automatically whenever
|
||||
a new document is uploaded or existing documents properties are modified.
|
||||
#. A new index should appear under :menuselection:`Indexes` menu.
|
||||
|
||||
@@ -18,5 +18,5 @@ 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
|
||||
within the user interface containing either an URL link to the document or
|
||||
the actual document as an attachment.
|
||||
|
||||
@@ -4,7 +4,7 @@ OCR backend
|
||||
|
||||
Mayan EDMS ships an OCR backend that uses the FLOSS engine Tesseract
|
||||
(https://github.com/tesseract-ocr/tesseract/), but it can
|
||||
use other engines. To support other engines crate a wrapper that subclasess the
|
||||
use other engines. To support other engines crate a wrapper that subclasses the
|
||||
``OCRBackendBase`` class defined in mayan/apps/ocr/classes. This subclass should
|
||||
expose the ``execute`` method. For an example of how the Tesseract backend
|
||||
is implemented take a look at the file ``mayan/apps/ocr/backends/tesseract.py``
|
||||
|
||||
@@ -10,7 +10,7 @@ Change the database manager
|
||||
===========================
|
||||
Use PostgreSQL or MySQL as the database manager.
|
||||
Tweak the memory setting of the database manager to increase memory allocation.
|
||||
More PostgreSQL especific examples are available in their wiki page:
|
||||
More PostgreSQL specific examples are available in their wiki page:
|
||||
https://wiki.postgresql.org/wiki/Performance_Optimization
|
||||
|
||||
Increase the number of Gunicorn workers
|
||||
|
||||
@@ -80,5 +80,5 @@ module. Example::
|
||||
WizardStep.deregister(WizardStepTags)
|
||||
|
||||
|
||||
This will cause the tags assigment step to not be assigned to the upload
|
||||
This will cause the tags assignment step to not be assigned to the upload
|
||||
wizard anymore.
|
||||
|
||||
@@ -70,7 +70,7 @@ Internally, workflows are implemented as a finite state machines
|
||||
that only one state can be the current active state for a workflow being
|
||||
executed. The other limitation of the current implementation is that every
|
||||
workflow needs at least one state marked as the initial state. These limitations
|
||||
are the result of a compromised in the design between flexilibiy and ease of
|
||||
are the result of a compromised in the design between flexibility and ease of
|
||||
use.
|
||||
|
||||
|
||||
@@ -78,7 +78,7 @@ Visualizations
|
||||
==============
|
||||
|
||||
The graphical representation of a workflow (or a finite state machine style
|
||||
in Mayan EDMS's case) is similar to a flowchart. The states are presetended
|
||||
in Mayan EDMS's case) is similar to a flowchart. The states are represented
|
||||
with circles. The transitions are represented with arrows. Circle with a
|
||||
double border represent the initial state of the workflow.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user