Documentation improvements.

- Fixing some typos.
- Quick review of the current state.

docs/index.rst

@@ -10,7 +10,7 @@ Getting help
 ============
 
 * Search for information in the `archives of the mayan-edms mailing list`_, or
-  `post a question`_.  If you prefer news servers, use the gateway provided by Gname_.
+  `post a question`_.  If you prefer news servers, use the gateway provided by Gmane_.
 * Report bugs with **Mayan EDMS** using Github's `ticket tracker`_.
 * Try the :doc:`FAQ <topics/faq>` -- it's got answers to many common questions.
 

docs/releases/1.1.rst

@@ -13,7 +13,7 @@ What's new in Mayan EDMS v1.1
 Celery
 ~~~~~~
 All background tasks processing has been converted to use Celery_. By default
-**Mayan EDMS** runs in "Eager" until a broker and result backend are configure
+**Mayan EDMS** runs in "Eager" until a broker and result backend are configured
 as per `Celery's documentation`_. This change made the built-in scheduler and
 job_processing apps obsolete, both were removed.
 
@@ -29,7 +29,7 @@ Removal of the splash screen
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The static image home screen has been replaced with a quick links view, showing
 the most used actions: Uploading documents, viewing recent documents, viewing
-all document and searching documents.
+all documents and searching documents.
 
 
 Sending and receiving documents via email
@@ -67,7 +67,7 @@ with the latest development version of **Mayan EDMS**.
 User locale profile (language and timezone)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Interface language and locale setting can now be setup for each user and are not
-installation wide as before. Date and times offests are automatically ajusted to
+installation wide as before. Date and times offsets are automatically ajusted to
 each user's timezone settings.
 
 
@@ -85,7 +85,7 @@ the type to which they are associated is updated.
 
 Optional and required metadata types
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Metadata types can now be assigned in two ways to documents types, as optiona or
+Metadata types can now be assigned in two ways to documents types, as optional or
 required. Values for required metadata types as the name implies, must be entered
 for documents to be able to be uploaded. Optional metadata types on the other hand
 can be left blank by the user.
@@ -128,13 +128,13 @@ Many new API endpoints have been added exposing the majority of **Mayan EDMS** f
 Messages contextual improvements
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Many updates and simplifications were made to the source text messages to reduce the
-dificulty of traslating **Mayan EDMS** and maintaing the contextual meaning of the
+difficulty of translating **Mayan EDMS** and maintaing the contextual meaning of the
 text messages.
 
 Improved method for custom settings
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Custom setting now use a string based value, it is longer needed to import
+Custom settings now use a string based value, it is longer needed to import
-classes when customizing a settings::
+classes when customizing a setting::
 
   from custom_app.backends import CustomStorageBackend
   DOCUMENTS_STORAGE_BACKEND = CustomStorageBackend

docs/topics/development.rst

@@ -5,7 +5,7 @@ Development
 
 **Mayan EDMS** is under active development, and contributions are welcome.
 
-If you have a feature request, suggestion, or bug reports, please open a new
+If you have a feature request, suggestion or bug report, please open a new
 issue on the `GitHub issue tracker`_. To submit patches, please send a pull
 request on GitHub_. Make sure to add yourself to the :ref:`contributors` file.
 
@@ -261,7 +261,7 @@ Views behavior
 Source Control
 --------------
 
-**Mayan EDMS** source is controlled with Git_
+**Mayan EDMS** source is controlled with Git_.
 
 The project is publicly accessible, hosted and can be cloned from **GitHub** using::
 
@@ -283,7 +283,7 @@ Git branch structure
     Released versions.
 
 
-Each release is tagged and available for download on the Downloads_ section of the **Mayan EDMS** repository on GitHub_
+Each release is tagged and available for download on the Downloads_ section of the **Mayan EDMS** repository on GitHub_.
 
 When submitting patches, please place your code in its own ``feature/`` branch prior to opening a pull request on GitHub_.
 
@@ -349,8 +349,8 @@ Then on a separate console launch a celery worker from the same provisioned Vagr
 
 Contributing changes
 --------------------
-Once your have create and committed some new code or feature, submit a Pull Request.
+Once your have created and committed some new code or feature, submit a Pull Request.
-Be sure to merge with mayan-edms/master before doing a pull request so that patches
+Be sure to merge with mayan-edms/development before doing a pull request so that patches
 apply as cleanly as possible.  If there are no conflicts, Pull Requests can be merged
 directly from Github otherwise a manual command line merge has to be done and
 your patches might take longer to get merged.
@@ -440,7 +440,7 @@ You can also generate the documentation in formats other than HTML.
 Translations
 ------------
 
-Translations are now being handled online via the **Transifex** website: https://www.transifex.com/projects/p/mayan-edms/.
+Translations are handled online via the **Transifex** website: https://www.transifex.com/projects/p/mayan-edms/.
 To create a translation team for a new language or contribute to an already
 existing language translation, create a **Transifex** account and contact
 the team coordinator of the respective language in which you are interested.

docs/topics/getting_started.rst

@@ -11,8 +11,8 @@ Document sources
 ----------------
 
 Document sources define from where documents will be uploaded or gathered.
-To do add a document source go to the ``Setup`` section, then to the ``Sources`` section.
+To add a document source go to the ``Setup`` section, then to the ``Sources`` section.
-To obtain the fastest working setup, create a new source of type ``Web forms``.
+To obtain the fastest working setup, create a new source of type ``Web form``.
 ``Web forms`` are just HTML forms with a ``Browse`` button that will open the file upload
 dialog when clicked. Name it something simple like ``Local documents`` and select whether or not
 compressed files uploaded from this source will be automatically decompressed and
@@ -35,10 +35,10 @@ Defining metadata
 With your document types defined it should be much easier now to define the required
 ``metadata`` for each of these document types. When creating ``metadata`` types,
 the first thing that will be needed is the internal name with which this metadata
-type will be referenced in other areas of **Mayan EDMS**. Internal name is like a
+type will be referenced in other areas of **Mayan EDMS**. The internal name must not
-variable so it should not contain spaces or uppercase characters. After the internal name,
+contain spaces or uppercase characters. After the internal name, enter the name that
-enter the name that will be visible to you and your users, this is usually the same as the
+will be visible to you and your users, which usually will be similar or the same as the
-internal name but with proper capitalization and spacing. The ``metadata types``
+internal name, but with proper capitalization and spacing. The ``metadata types``
 can have default values to speed up data entry. They can be single number or a
 words enclosed in quotes, ie::
 
@@ -64,16 +64,16 @@ this will ensure an unified data entry formatting. You can also use a
 
 Metadata types can be assigned in two ways to a document type, by making it an
 optional or a required metadata type for a specific document. This method
-allows metadata that is very important to some types of documents, like Invoice
+allows metadata very important for some types of documents (like Invoice
-numbers to Invoices to be required in other for an Invoice to be able to be uploaded.
+numbers to Invoices) to be required for an Invoice to be able to be uploaded.
-Accordingly optional metadata types will presented but users are not required to
+Accordingly optional metadata types will be presented, but users are not required to
-enter a value in other to be able to upload a document.
+enter a value to be able to upload a document.
 
 Indexes
 -------
 
 After defining all your metadata types you can also define indexes to
-let **Mayan EDMS** to automatically categorize your documents based on their metadata values.
+let **Mayan EDMS** automatically categorize your documents based on their metadata values.
 To create an index to organize invoices by a year metadata field do the following:
 
 - Create a year metadata type with the name ``year`` and the label ``Year``.

docs/topics/permissions.rst

@@ -2,7 +2,7 @@
 Permissions
 ===========
 
-**Mayan EDMS** provides very exact control over what activies users can
+**Mayan EDMS** provides finegrained control over which activities users can
 perform. This control is divided into two levels of operation:
 
 2 tier permissions assignement
@@ -10,8 +10,8 @@ perform. This control is divided into two levels of operation:
 
 This level of activity control works by allowing roles that are composed
 of users or groups, to be granted a permission such that the holder of that
-permission can exercise it throught the entire collection of objects
+permission can exercise it throughout the entire collection of objects
-(document, folders, tags, etc), this method could be thought out as a global
+(document, folders, tags, etc). This method could be thought out as a global
 permission.
 
 3 tier access control
@@ -24,24 +24,24 @@ to a selected object. Example: Granting user
 ``Joe`` the ``Document view`` access control for document ``Payroll``, would
 allow him to view this document only.
 
-The permission system enforces inheritance by first checking if the user
+The permission system enforces inheritance by first checking, if the user
 has a global permission, is a member of a group or a role that has a global
-permission and if not then checks to see if that user, a group or role to
+permission and if not, then checks to see if that user, a group or role to
 which he belongs, has been granted access to the specific object to which
-he is desiring to perform a given action that requires a permission.
+he is desiring to perform a given action.
 
-Only when these checks fails the user is forbidden to perform the action and
+Only when these checks fail the user is forbidden to perform the action and
-a generic message indicating this is displayed to avoid providing any information
+a generic message is displayed to avoid providing any information
 that could be used to sidetrack the permission system or obtain any kind of
-information about the object from which the user was not allowed access.
+information about the object to which the user was not allowed access.
 
 Default Access Control Lists (Default ACLs)
 -------------------------------------------
 
-Default Access Control Lists allow assigment of an access control list to an a
+Default Access Control Lists allow assigment of an access control list to a
 type of object (Document, Tags, Folders) before it is created. It is the default
 permissions an object will have when it is created. With Default Access Control Lists
-specific permissions can be granted to the creator of a document por example.
+specific permissions can be granted to the creator of a document for example.
 
 Changes to the Default Access Control Lists (Default ACLs) only affect objects
-created after the change, it will not work for documents previously uploaded.
+created after the change, they will not affect documents previously uploaded.

docs/topics/signatures.rst

@@ -2,11 +2,11 @@
 Document signatures
 ===================
 
-**Mayan EDMS** supports two types of document signatures, these are embedded and
+**Mayan EDMS** supports two types of document signatures: embedded and
 detached signatures. When a document with an embedded signature is
 uploaded, this signature is readily detected as part of the document
-inspection step, the status of the signature can then be verified by accessing the
+inspection step. The status of the signature can be verified by accessing the
-signatures sections of a documents.
+signatures sections of a document.
 
 Existing non signed documents can be signed in one of two ways:
 by downloading the document, signing it, and uploading the signed document

docs/topics/smart_links.rst

@@ -4,7 +4,7 @@ Smart links
 
 
 Smart links are usefull for navigation between documents. They are rule
-based but don't create any organizational structure, just show the documents
+based, but don't create any organizational structure. They just show the documents
 that match the rules as evaluated against the metadata of the currently
 displayed document.
 

docs/topics/tags.rst

@@ -3,7 +3,7 @@ Tags
 ====
 
 Tags allow giving documents a toggable property. Documents can also be tagged
-with more than one tag. Once tagged, documents can be search also by their tags
+with more than one tag. Once tagged, documents can be searched also by their tags
 and from the tags main menu a list of all the documents with a particular tag
 can be obtained easily. Aside from their texts, tags can be assigned a particular
 color.

docs/topics/transformations.rst

@@ -5,8 +5,8 @@ What are transformations?
 Transformation are useful to manipulate the preview of the stored documents
 in a persistent manner, for example some scanning equipment only produce
 landscape PDFs, in this case a default transformation for that document
-source would be "rotation: 270 degress", this way whenever a document is
+source would be "rotation: 270 degress". This way whenever a document is
 uploaded from that scanner it appears in portrait orientation.
-The transformation remains attached to the document, this way the file
+The transformation remains attached to the document, the file being
-is preserved in it's original state (a requirement in legal environments)
+preserved in it's original state (a requirement in legal environments) and
-but only the representation is transformed.
+only the representation being transformed.