From 0299353fb7fefbc57c153233bd9c95508e5fe1ad Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Tue, 26 Apr 2016 16:52:17 -0400 Subject: [PATCH] Remove bold markup from all mentions of "Mayan EDMS" --- README.rst | 2 +- docs/index.rst | 8 ++++---- docs/releases/0.12.1.rst | 6 +++--- docs/releases/0.12.2.rst | 10 +++++----- docs/releases/0.12.rst | 12 ++++++------ docs/releases/0.13.rst | 28 ++++++++++++++-------------- docs/releases/1.0.rst | 4 ++-- docs/releases/1.1.rst | 22 +++++++++++----------- docs/releases/2.0.rst | 10 +++++----- docs/releases/index.rst | 8 ++++---- docs/topics/acls.rst | 2 +- docs/topics/app_creation.rst | 6 +++--- docs/topics/contact.rst | 6 +++--- docs/topics/contributors.rst | 2 +- docs/topics/deploying.rst | 10 +++++----- docs/topics/development.rst | 18 +++++++++--------- docs/topics/document_types.rst | 4 ++-- docs/topics/faq.rst | 2 +- docs/topics/features.rst | 6 +++--- docs/topics/file_storage.rst | 4 ++-- docs/topics/index.rst | 2 +- docs/topics/indexes.rst | 2 +- docs/topics/installation.rst | 18 +++++++++--------- docs/topics/license.rst | 2 +- docs/topics/permissions.rst | 2 +- docs/topics/signatures.rst | 2 +- docs/topics/versioning.rst | 2 +- 27 files changed, 100 insertions(+), 100 deletions(-) diff --git a/README.rst b/README.rst index 7e5266c94b..b1e6aee675 100644 --- a/README.rst +++ b/README.rst @@ -27,7 +27,7 @@ This project is open sourced under `Apache 2.0 License`_. Installation ------------ -To install **Mayan EDMS**, simply do: +To install Mayan EDMS, simply do: .. code-block:: bash diff --git a/docs/index.rst b/docs/index.rst index 17cee38e60..4e08474c94 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,16 @@ Welcome to Mayan EDMS! ====================== -**Mayan EDMS** is a `Free Open Source`_ `Electronic Document Management System`_, coded in +Mayan EDMS is a `Free Open Source`_ `Electronic Document Management System`_, coded in the Python language using the Django_ web application framework and released under the `Apache 2.0 License`_. It provides an electronic vault or repository for electronic documents. -The easiest way to install and try **Mayan EDMS** is by using a Debian based Linux distribution -and installing it from PyPI with the following commands: +The easiest way to use Mayan EDMS is by using a Debian based Linux distribution +and install it from PyPI with the following commands: .. code-block:: bash - sudo apt-get install libjpeg-dev libmagic1 libpng-dev libreoffice libtiff-dev gcc ghostscript gpgv python-dev python-virtualenv tesseract-ocr unpaper poppler-utils -y + sudo apt-get install libjpeg-dev libmagic1 libpng-dev libreoffice libtiff-dev gcc ghostscript gpgv python-dev python-virtualenv tesseract-ocr poppler-utils -y virtualenv venv source venv/bin/activate pip install mayan-edms diff --git a/docs/releases/0.12.1.rst b/docs/releases/0.12.1.rst index cce015965f..696fe889d8 100644 --- a/docs/releases/0.12.1.rst +++ b/docs/releases/0.12.1.rst @@ -25,9 +25,9 @@ What's new in Mayan EDMS v0.12.1 Fabric file (fabfile) ~~~~~~~~~~~~~~~~~~~~~ A Fabric file is included to help users not very familiar with Ubuntu, -Python and Django install **Mayan EDMS**, or for system administrators +Python and Django install Mayan EDMS, or for system administrators looking to automate the install whether in local or remote systems. -At the moment the fabfile will install **Mayan EDMS** in the same configurations +At the moment the fabfile will install Mayan EDMS in the same configurations listed in this documentation, that is: (Ubuntu/Debian/Fedora) + virtualenv + Apache + MySQL. Feel free to submit your configuration settings and files for different databases, webserver or Linux distribution. More configurations will be added to @@ -38,7 +38,7 @@ Documentation update The installation instructions were updated to include the installation of the libpng-dev and libjpeg-dev libraries as well as the installation of the poppler-utils package. An additional step to help users test their -new installation of **Mayan EDMS** was also added. +new installation of Mayan EDMS was also added. Translations ~~~~~~~~~~~~ diff --git a/docs/releases/0.12.2.rst b/docs/releases/0.12.2.rst index b0bcc4aa45..7e0a8ccd4b 100644 --- a/docs/releases/0.12.2.rst +++ b/docs/releases/0.12.2.rst @@ -24,7 +24,7 @@ What's new in Mayan EDMS v0.12.2 Smarter auto admin creation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**Mayan EDMS** creates a administrator user during the +Mayan EDMS creates a administrator user during the database creation phase to reduce the amount of steps required for a functional install. The creation of this account is controlled by the configuration option `COMMON_AUTO_CREATE_ADMIN`, the username of the account is @@ -41,7 +41,7 @@ As per the feature request filed under `issue #26`_, a new document check out and check in functionality has been added. Users can now check out a document and lock new version of it from being uploaded to avoid editing conflicts. Document check outs have an expiration period after which -**Mayan EDMS** will automatically check them back in to avoid a permanent +Mayan EDMS will automatically check them back in to avoid a permanent document lockout. Only the user who has checked out a document can upload new versions of it or check the document back in before the expiration period, unless being granted the ``Allow overriding check out restrictions`` or @@ -52,14 +52,14 @@ Installation environment app Diagnosting remote installations of web based applications without access to the command line can be a bit hard, to alleviate this situation a new installation environment details app has been added. The purpose of this app is to provide -support staff information about the physical environment where **Mayan EDMS** has +support staff information about the physical environment where Mayan EDMS has been installed. To avoid possible security compromises only administrators can access this app. Editable compressed documents filename ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Previously when downloading more than one document in a compressed manner, -**Mayan EDMS** would produce a file with the name ``document_bundle.zip`` for +Mayan EDMS would produce a file with the name ``document_bundle.zip`` for download. A different filename can now be specified at the same download dialog. German translation @@ -71,7 +71,7 @@ Statistics gathering ~~~~~~~~~~~~~~~~~~~~ Previous attempts at gathering usage statistics have been met with deficient results. User participation in surveys as well as the quality of the data entered by users -was disappointing. That is why this version of **Mayan EDMS** features an +was disappointing. That is why this version of Mayan EDMS features an anonymous statistics gathering functionality. diff --git a/docs/releases/0.12.rst b/docs/releases/0.12.rst index d46b3cb0a4..d4bc23b52f 100644 --- a/docs/releases/0.12.rst +++ b/docs/releases/0.12.rst @@ -6,12 +6,12 @@ Mayan EDMS v0.12 release notes Welcome to Mayan EDMS v0.12! -This release commemorates **Mayan EDMS** first aniversary! +This release commemorates Mayan EDMS first aniversary! Overview ======== -Aside from new features, the focus of this release of **Mayan EDMS** also +Aside from new features, the focus of this release of Mayan EDMS also been about improving the code and documentation quality standard even further. The permission system has been completely overhauled to make it entire class based. The other big change is the addition of object @@ -61,7 +61,7 @@ Anonymous user support ~~~~~~~~~~~~~~~~~~~~~~ Anonymous user support is a two tier function, first is the addition of the `COMMON_ALLOW_ANONYMOUS_ACCESS` configuration option that -allows non authenticated user to browse all the pages of a **Mayan EDMS** installation. +allows non authenticated user to browse all the pages of a Mayan EDMS installation. The second part of this support is the ability to assign permissions or individual access to objects to anonymous users. @@ -89,7 +89,7 @@ the download of several documents in a single compressed file. Customizable GPG home directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Addition of the `SIGNATURES_GPG_HOME` configuration option to let -administrators set **Mayan EDMS**'s GPG instance home directory, used to +administrators set Mayan EDMS's GPG instance home directory, used to store keyrings and other GPG configuration files. Out of process bulk uploading @@ -114,7 +114,7 @@ stage to beta stage. Index configuration menus are now available on the be populated with document links depending on their metadata and properties. These populated trees can also be mirrored on the physical filesystem and shared using Samba or another filesharing server giving users a structured view -of the documents contained within **Mayan EDMS** from the ``Indexes`` tab +of the documents contained within Mayan EDMS from the ``Indexes`` tab or from a mirrored index shared via the network. A new configuration option has been added, `DOCUMENT_INDEXING_FILESYSTEM_SERVING`, which maps the index internal name with the physical directory where such index will be @@ -127,7 +127,7 @@ Included in this version is a small feedback application, found under the help determine the priority of the next planned features on the pipeline, or even help add new features if enough requests are received. All questions are optional but answering as many as possible will help greatly understand -the need of the **Mayan EDMS** user base. +the need of the Mayan EDMS user base. Staging file previews ~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/releases/0.13.rst b/docs/releases/0.13.rst index 36d1c11969..02c292557d 100644 --- a/docs/releases/0.13.rst +++ b/docs/releases/0.13.rst @@ -31,39 +31,39 @@ Attaching or removing tags from a large number of documents is now much easier. Registration ~~~~~~~~~~~~ Based on requests made by the community for greater commercial support and services for -**Mayan EDMS**, a new feature has been added that allows users to register their -copies of **Mayan EDMS** and better help users with commercial support packages. +Mayan EDMS, a new feature has been added that allows users to register their +copies of Mayan EDMS and better help users with commercial support packages. Registration for non commercial users is voluntary and optional, and in no way -affects the functionality of **Mayan EDMS**. However even for non commercial users +affects the functionality of Mayan EDMS. However even for non commercial users registration offers the advantage of automatically branding the user's copy -of **Mayan EDMS** with their name or the company name in the title area. +of Mayan EDMS with their name or the company name in the title area. Per document type indexing ~~~~~~~~~~~~~~~~~~~~~~~~~~ Index can now be restricted to update only on specific document types, this greatly increases the usefulness of indexes, and prevents unwanted index -updates. +updates. Bootstrap ~~~~~~~~~ -Setting up **Mayan EDMS** after installation has been indetified by users as the -main difficulty when knowledge about **Mayan EDMS** is relatively low. To +Setting up Mayan EDMS after installation has been indetified by users as the +main difficulty when knowledge about Mayan EDMS is relatively low. To address this situation a new feature that provides preconfigured setups has been -added. These preconfigured setups are published in the **Mayan EDMS** website and +added. These preconfigured setups are published in the Mayan EDMS website and upon synchonization are available to users, this gives users access and integrators -access to new setups without having to wait for new versions of **Mayan EDMS**. +access to new setups without having to wait for new versions of Mayan EDMS. Aside from including preconfigured setups, the new bootstrap app has the ability of dumping an user's current setup into a serialized text file which can be tweaked by hand and sent via email to other users. The possibilities enabled by this range from company wide defaults setups to consultants providing their clients with customized setups without having to access their clients' -**Mayan EDMS** instances. ``JSON``, ``YAML`` and a custom ``YAML`` format +Mayan EDMS instances. ``JSON``, ``YAML`` and a custom ``YAML`` format (http://djangosnippets.org/snippets/2461/) are supported by this new app. Add documents to folders in bulk ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As requested, the ability to add more than one document at a time to a selected -folder has been added. +folder has been added. Translation updates ~~~~~~~~~~~~~~~~~~~ @@ -96,7 +96,7 @@ removes any traces of code and configuration options related to UNOCONV. Optimizations ~~~~~~~~~~~~~ -Inspired by the idea of getting **Mayan EDMS** running effectively on low power hardware such as +Inspired by the idea of getting Mayan EDMS running effectively on low power hardware such as the Raspberry Pi, several rounds or profiling and optimization were done. Some caching optimization were introduced to the permission model, resulting in @@ -105,13 +105,13 @@ and a 18% query reduction on cache hits. Upgrading from a previous version ================================= -If you installed **Mayan EDMS** by cloning the Git repository issue the commands:: +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. - + Next add the new requirements:: $ pip install -r requirements/production.txt diff --git a/docs/releases/1.0.rst b/docs/releases/1.0.rst index b927dde7e6..49246f1258 100644 --- a/docs/releases/1.0.rst +++ b/docs/releases/1.0.rst @@ -118,7 +118,7 @@ to do document OCR using software or services other than Tesseract. OCR improvements ~~~~~~~~~~~~~~~~ -OCR queue state is now reset when reloading **Mayan EMDS**, avoiding the OCR queue +OCR queue state is now reset when reloading Mayan EMDS, avoiding the OCR queue to remain locked. `unpaper` binary is now an optional pre OCR requirement, the OCR queue will now continue working is `unpaper` is not installed. Addition of post OCR processing support for French and German. @@ -131,7 +131,7 @@ commercial products is now explicitly allowed. PyPI package ~~~~~~~~~~~~ -**Mayan EDMS** has been packaged and submitted to the PyPI_ Python Package Index +Mayan EDMS has been packaged and submitted to the PyPI_ Python Package Index making it even easier to install and use. New REST API diff --git a/docs/releases/1.1.rst b/docs/releases/1.1.rst index 9f9a3d11c2..718f4111d1 100644 --- a/docs/releases/1.1.rst +++ b/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 configured +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. @@ -21,7 +21,7 @@ job_processing apps obsolete, both were removed. Views namespaces ~~~~~~~~~~~~~~~~ All views are namespaced_ with the name of the app which defines them. If you have -developed 3rd party apps for **Mayan EDMS** be sure to update any reference to a view +developed 3rd party apps for Mayan EDMS be sure to update any reference to a view by prepending the app name to the view name. @@ -43,7 +43,7 @@ mail serving. Update to Django 1.6.8 ~~~~~~~~~~~~~~~~~~~~~~ -**Mayan EDMS** has been updated to use Django 1.6.8. +Mayan EDMS has been updated to use Django 1.6.8. Events app @@ -55,13 +55,13 @@ for `Django activity stream`_ Watch folders ~~~~~~~~~~~~~ Filesystem folders can be monitored for change and their files automatically -uploaded as documents in **Mayan EDMS**. +uploaded as documents in Mayan EDMS. Vagrant file included ~~~~~~~~~~~~~~~~~~~~~ A vagrant file is now included to allow developers to provision a virtual machine -with the latest development version of **Mayan EDMS**. +with the latest development version of Mayan EDMS. User locale profile (language and timezone) @@ -101,7 +101,7 @@ the metadata types of the new document type are automatically assigned. New release cycle ~~~~~~~~~~~~~~~~~ Starting with this version a new release cycle methodology will come into effect. -The goal of this release cycle is to allow two series of versions of **Mayan EDMS** to be +The goal of this release cycle is to allow two series of versions of Mayan EDMS to be active at a given time: A new major version with new functionality and a minor version providing upgrades and fixes. This release (1.1) will be active and supported during releases of versions 2.x, but will go into end-of-life as soon as @@ -111,24 +111,24 @@ maintenance mode. Deprecation of Python 2.6 ~~~~~~~~~~~~~~~~~~~~~~~~~ -Series 1.0 of **Mayan EDMS** will be the last series supporting Python 2.6. Series +Series 1.0 of Mayan EDMS will be the last series supporting Python 2.6. Series 2.0 will be using Django 1.7.x which itself requires Python 2.7 or later. Improved testings ~~~~~~~~~~~~~~~~~ -**Mayan EDMS** is now automatically tested against SQLite, MySQL and PostgreSQL. +Mayan EDMS is now automatically tested against SQLite, MySQL and PostgreSQL. API updates ~~~~~~~~~~~ -Many new API endpoints have been added exposing the majority of **Mayan EDMS** functionality. +Many new API endpoints have been added exposing the majority of Mayan EDMS functionality. Messages contextual improvements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Many updates and simplifications were made to the source text messages to reduce the -difficulty of translating **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 @@ -186,7 +186,7 @@ More technical documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Many new sub topics were added to the development section of the documentation to allow developers to better understand the inner workings and philosophies -of **Mayan EDMS**. +of Mayan EDMS. Other changes diff --git a/docs/releases/2.0.rst b/docs/releases/2.0.rst index d8fd7806cb..6487d479d6 100644 --- a/docs/releases/2.0.rst +++ b/docs/releases/2.0.rst @@ -13,7 +13,7 @@ What's new in Mayan EDMS v2.0 Update to Django 1.7 -------------------- The biggest change of this release comes in the form of support for Django 1.7. -**Mayan EDMS** makes use of several new features of Django 1.7 like: migrations, +Mayan EDMS makes use of several new features of Django 1.7 like: migrations, app config and transaction handling. The version of Django supported in this version is 1.7.10. With the move to Django 1.7, support for South migrations and Python 2.6 is removed. The switch to Django 1.7's app config means that @@ -30,7 +30,7 @@ Theming and re-branding ---------------------- All the presentation logic and markup has been moved into it's own app, the 'appearance' app. All modifications required to customize the entire look of -the **Mayan EDMS** can now be done in a single app. Very little markup remains +the Mayan EDMS can now be done in a single app. Very little markup remains in the other apps, and it's usually because of necessity, namely the widgets.py modules. @@ -194,11 +194,11 @@ Failure tolerance ----------------- Previous versions made use of transactions to prevent data loss in the event of an unexpected error. This release improves on that approach by also reacting -to infrastructure failures. **Mayan EDMS** can now recover without any or +to infrastructure failures. Mayan EDMS can now recover without any or minimal data loss from critical events such as loss of connectivity to the database manager. This changes allow installation of using database managers that do not provide guaranteed concurrency such as SQLite, to scale to thousand -of documents. While this configuration is still not recommended, **Mayan EDMS** +of documents. While this configuration is still not recommended, Mayan EDMS will now work and scale much better in environments where parts of the infrastructure cannot be changed (such as the database manager). @@ -219,7 +219,7 @@ new scheme. Default document type and default document source ------------------------------------------------- After installation a default document type and document source are created, -this means that users can start uploading documents as soon as **Mayan EDMS** +this means that users can start uploading documents as soon as Mayan EDMS is installed without having to do any configuration setting changes. The default document type and default document source are both called 'Default'. diff --git a/docs/releases/index.rst b/docs/releases/index.rst index ceabfccbb1..e639f5381c 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -2,19 +2,19 @@ Release notes ============= -Release notes for the official **Mayan EDMS** releases. Each release note will tell you +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 changes made in that version. -For those upgrading to a new version of **Mayan EDMS**, you will need to check +For those upgrading to a new version of Mayan EDMS, you will need to check all the backwards-incompatible changes and deprecated features for -each 'final' release from the one after your current **Mayan EDMS** version, +each 'final' release from the one after your current Mayan EDMS version, up to and including the latest version. Final releases ============== -Below are release notes through **Mayan EDMS** |version| and its minor releases. Newer +Below are release notes through Mayan EDMS |version| and its minor releases. Newer versions of the documentation contain the release notes for any later releases. 2.0 series diff --git a/docs/topics/acls.rst b/docs/topics/acls.rst index 2ca9d758e9..0e6dd26d0f 100644 --- a/docs/topics/acls.rst +++ b/docs/topics/acls.rst @@ -2,7 +2,7 @@ Access control lists ==================== -Besides the permissions system explained in :doc:`permissions`, **Mayan EDMS** +Besides the permissions system explained in :doc:`permissions`, Mayan EDMS provides per object permission granting. This feature is used to grant a permission to a role, but this permission can only be executed for a limited number of objects (documents, folders, tags) instead of being effective diff --git a/docs/topics/app_creation.rst b/docs/topics/app_creation.rst index 09399b1e73..81680bfc41 100644 --- a/docs/topics/app_creation.rst +++ b/docs/topics/app_creation.rst @@ -2,7 +2,7 @@ App creation ============ -**Mayan EDMS** apps are essentially Django app with some extra code to register +Mayan EDMS apps are essentially Django app with some extra code to register navigation, permissions and other relationships. @@ -21,7 +21,7 @@ App modules - api_views.py - REST API views go here. **Mayan EDMS** uses Django REST Framework API view + REST API views go here. Mayan EDMS uses Django REST Framework API view classes. - apps.py @@ -135,7 +135,7 @@ Views ===== The module common.generics provides custom generic class based views to be used. -The basic views used to create, edit, view and delete objects in **Mayan EDMS** +The basic views used to create, edit, view and delete objects in Mayan EDMS are: SingleObjectCreateView, SingleObjectDetailView, SingleObjectEditView, and SingleObjectListView diff --git a/docs/topics/contact.rst b/docs/topics/contact.rst index ee27f3057d..15a779c426 100644 --- a/docs/topics/contact.rst +++ b/docs/topics/contact.rst @@ -15,14 +15,14 @@ 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 Gmane_. -**Mayan EDMS** community developers do their best to reply to basic questions. +Mayan EDMS community developers do their best to reply to basic questions. Be sure to check the list archives as it may already containt the answers to your questions. Twitter ------- -**Mayan EDMS** has an official Twitter account, `@mayanedms +Mayan EDMS has an official Twitter account, `@mayanedms `_, which is used for announcements and occasional related news tidbits. @@ -30,7 +30,7 @@ related news tidbits. Bugs/ticket tracker ------------------- -Report bugs with **Mayan EDMS** or search existing ones using Github's `ticket tracker`_. +Report bugs with Mayan EDMS or search existing ones using Gitlab's `ticket tracker`_. .. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/ diff --git a/docs/topics/contributors.rst b/docs/topics/contributors.rst index e9baed1e35..59989fe853 100644 --- a/docs/topics/contributors.rst +++ b/docs/topics/contributors.rst @@ -8,7 +8,7 @@ Contributors How to contribute? ------------------ -You can help further the development of **Mayan EDMS** by testing, reporting +You can help further the development of Mayan EDMS by testing, reporting bugs, submitting documentation or code patches. Lead developer diff --git a/docs/topics/deploying.rst b/docs/topics/deploying.rst index 0f7305fbc2..9e322148d2 100644 --- a/docs/topics/deploying.rst +++ b/docs/topics/deploying.rst @@ -5,7 +5,7 @@ Deploying OS "bare metal" =============== -Like other Django based projects **Mayan EDMS** can be deployed in a wide variety +Like other Django based projects Mayan EDMS can be deployed in a wide variety of ways. The method provided below is only a bare minimum example. These instructions are independent of the instructions mentioned in the :doc:`installation` chapter but assume you have already made a test install to @@ -109,7 +109,7 @@ Create the directory for the uWSGI log files:: mkdir /var/log/uwsgi -Create the NGINX site file for **Mayan EDMS**, ``/etc/nginx/sites-available/mayan``:: +Create the NGINX site file for Mayan EDMS, ``/etc/nginx/sites-available/mayan``:: server { listen 80; @@ -134,7 +134,7 @@ Create the NGINX site file for **Mayan EDMS**, ``/etc/nginx/sites-available/maya } } -Enable the NGINX site for **Mayan EDMS**:: +Enable the NGINX site for Mayan EDMS:: ln -s /etc/nginx/sites-available/mayan /etc/nginx/sites-enabled/ @@ -198,7 +198,7 @@ Deploy the Docker image stack:: docker run --name redis -d redis docker run --name mayan-edms -p 80:80 --link postgres:postgres --link redis:redis -e POSTGRES_DB=mayan -e POSTGRES_USER=mayan -e POSTGRES_PASSWORD=mysecretpassword -v /usr/local/lib/python2.7/dist-packages/mayan/media -d mayanedms/monolithic -After the **Mayan EDMS** container finishes initializing (about 5 minutes), it will +After the Mayan EDMS container finishes initializing (about 5 minutes), it will be available by browsing to http://127.0.0.1. You can inspect the initialization with:: @@ -242,7 +242,7 @@ Launch the entire stack (Postgres, Redis, and Mayan EDMS) using:: docker-compose -f docker-compose.yml -p mayanedms up -d -After the **Mayan EDMS** container finishes initializing (about 5 minutes), it will +After the Mayan EDMS container finishes initializing (about 5 minutes), it will be available by browsing to http://127.0.0.1. You can inspect the initialization with:: diff --git a/docs/topics/development.rst b/docs/topics/development.rst index abbbb11d89..5654918326 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -3,7 +3,7 @@ Development =========== -**Mayan EDMS** is under active development, and contributions are welcome. +Mayan EDMS is under active development, and contributions are welcome. If you have a feature request, suggestion or bug report, please open a new issue on the `GitLab issue tracker`_. To submit patches, please send a pull @@ -16,8 +16,8 @@ request on GitLab_. Make sure to add yourself to the :ref:`contributors` file. Project philosophies -------------------- -How to think about **Mayan EDMS** when doing changes or adding new features, -why things are the way they are in **Mayan EDMS**. +How to think about Mayan EDMS when doing changes or adding new features, +why things are the way they are in Mayan EDMS. - Functionality must be as market/sector independent as possible, code for the 95% of use cases. @@ -125,7 +125,7 @@ Correct: Dependencies ~~~~~~~~~~~~ -**Mayan EDMS** apps follow a hierarchical model of dependency. Apps import from +Mayan EDMS apps follow a hierarchical model of dependency. Apps import from their parents or siblings, never from their children. Think plugins. A parent app must never assume anything about a possible existing child app. The documents app and the Document model are the basic entities they must never @@ -136,7 +136,7 @@ Variables ~~~~~~~~~ Naming of variables should follow a Major to Minor convention, usually including the purpose of the variable as the first piece of the name, using -underscores as spaces. camelCase is not used in **Mayan EDMS**. +underscores as spaces. camelCase is not used in Mayan EDMS. Examples: @@ -171,7 +171,7 @@ Classes: Strings ~~~~~~~ -Quotation character used in **Mayan EDMS** for strings is the single quote. +Quotation character used in Mayan EDMS for strings is the single quote. Double quote is used for multiple line comments or HTML markup. Migrations @@ -199,7 +199,7 @@ as passed directly from the exception object. 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 **GitLab** using:: @@ -209,7 +209,7 @@ The project is publicly accessible, hosted and can be cloned from **GitLab** usi Git branch structure -------------------- -**Mayan EDMS** follows a simplified model layout based on Vincent Driessen's +Mayan EDMS follows a simplified model layout based on Vincent Driessen's `Successful Git Branching Model`_ blog post. ``develop`` @@ -299,7 +299,7 @@ merged. Debugging --------- -**Mayan EDMS** makes extensive use of Django's new `logging capabilities`_. +Mayan EDMS makes extensive use of Django's new `logging capabilities`_. By default debug logging for all apps is turned on. If you wish to customize how logging is managed turn off automatic logging by setting `COMMON_AUTO_LOGGING` to ``False`` and add the following lines to your diff --git a/docs/topics/document_types.rst b/docs/topics/document_types.rst index 694b343153..f5d8b9893b 100644 --- a/docs/topics/document_types.rst +++ b/docs/topics/document_types.rst @@ -2,7 +2,7 @@ Document types ============== -The basic unit of data in **Mayan EDMS** is the ``document type``. A document +The basic unit of data in Mayan EDMS is the ``document type``. A document type can be interpreted also as a document category, a document class, or a document template. Document types need to be created before documents can be uploaded. It is not possible to upload documents without assigning them a @@ -11,7 +11,7 @@ document type. Examples of document type: **invoices**, **blueprints**, Settings and attributes are applied to document types and documents will inherit those settings and attributes based on the document type they were -assigned when uploaded into **Mayan EDMS**. A document can only be of one +assigned when uploaded into Mayan EDMS. A document can only be of one type at a given moment, but if needed, the type of a document can be changed. Upon changing its type, the document will lose its previous settings and attributes, and will inherit the settings and attributes of its new type. diff --git a/docs/topics/faq.rst b/docs/topics/faq.rst index d35da8698a..236d0f359a 100644 --- a/docs/topics/faq.rst +++ b/docs/topics/faq.rst @@ -7,7 +7,7 @@ Frequently asked questions and solutions **Q: PostgreSQL vs. MySQL** Since Django abstracts database operations from a functional point of view -**Mayan EDMS** will behave exactly the same either way. The only concern +Mayan EDMS will behave exactly the same either way. The only concern would be that MySQL doesn't support transactions for schema modifying commands. The only moment this could cause problems is when running South migrations during upgrades, if a migration fails the database diff --git a/docs/topics/features.rst b/docs/topics/features.rst index 1e79b2c88f..33d32c7159 100644 --- a/docs/topics/features.rst +++ b/docs/topics/features.rst @@ -19,7 +19,7 @@ Features * Office document format support. - * **Mayan EDMS** can detect the presence of Libre Office and use it to support + * Mayan EDMS can detect the presence of Libre Office and use it to support word processing files, spreadsheets and presentations. * User defined metadata fields. @@ -44,7 +44,7 @@ Features * Previews for many file formats. - * **Mayan EDMS** provides image preview generation for many popular file + * Mayan EDMS provides image preview generation for many popular file formats. * Full text searching. @@ -78,7 +78,7 @@ Features * Multilingual user interface. - * **Mayan EDMS** being written using the Django_ framework, can be translated + * Mayan EDMS being written using the Django_ framework, can be translated to practically any language spoken in the world. For a list of translated languages have a look at the Transifex_ project location. diff --git a/docs/topics/file_storage.rst b/docs/topics/file_storage.rst index 955a79a66e..f02e38d7aa 100644 --- a/docs/topics/file_storage.rst +++ b/docs/topics/file_storage.rst @@ -2,7 +2,7 @@ File storage ============ -The files are stored and placed under **Mayan EDMS** "control" to avoid +The files are stored and placed under Mayan EDMS "control" to avoid filename clashes each file gets renamed to its ``UUID`` (Universally Unique ID), without extension, and stored in a simple flat arrangement in a directory. @@ -20,7 +20,7 @@ This doesn't stop access to the files but renaming, moving or updating directly them is not recommended because it would throw the database out of sync. -Because **Mayan EDMS** components are as decoupled from each other as possible, +Because Mayan EDMS components are as decoupled from each other as possible, storage in this case is decoupled and its behavior is controlled not by the project but by the ``Storage`` module class. All the other modules don't make any assumptions about how the actual document files are diff --git a/docs/topics/index.rst b/docs/topics/index.rst index b0c90a4e07..3b780c58e2 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -1,7 +1,7 @@ Concepts ======== -Introductions to all the key parts of **Mayan EDMS** you'll need to know: +Introductions to all the key parts of Mayan EDMS you'll need to know: .. toctree:: :maxdepth: 1 diff --git a/docs/topics/indexes.rst b/docs/topics/indexes.rst index 665af61a05..8990fa6064 100644 --- a/docs/topics/indexes.rst +++ b/docs/topics/indexes.rst @@ -17,7 +17,7 @@ Example: - Metadata type: ``Product year``, associated as a required metadata for the document type ``Product sheet``. - Index: ``Product sheets per year``, and associated to the document type ``Product sheet``. -- Index slug: ``product-sheets-per-year``. Slugs are internal unique identifiers that can be used by other **Mayan EDMS** modules to reference each index. +- Index slug: ``product-sheets-per-year``. Slugs are internal unique identifiers that can be used by other Mayan EDMS modules to reference each index. - Index tree template as follows: .. blockdiag:: diff --git a/docs/topics/installation.rst b/docs/topics/installation.rst index a7b365fe91..813f6a03c0 100644 --- a/docs/topics/installation.rst +++ b/docs/topics/installation.rst @@ -2,11 +2,11 @@ Installation ============ -**Mayan EDMS** should be deployed like any other Django_ project and +Mayan EDMS should be deployed like any other Django_ project and preferably using virtualenv_. Being a Django_ and a Python_ project, familiarity with these technologies is -recommended to better understand why **Mayan EDMS** does some of the things it +recommended to better understand why Mayan EDMS does some of the things it does. Bellow are the step needed for a test install. @@ -20,13 +20,13 @@ Ubuntu If using a Debian_ or Ubuntu_ based Linux distribution, get the executable requirements using:: - sudo apt-get install libjpeg-dev libmagic1 libpng-dev libreoffice libtiff-dev gcc ghostscript gpgv python-dev python-virtualenv tesseract-ocr unpaper poppler-utils -y + sudo apt-get install libjpeg-dev libmagic1 libpng-dev libreoffice libtiff-dev gcc ghostscript gpgv python-dev python-virtualenv tesseract-ocr poppler-utils -y Mac OSX ------- -**Mayan EDMS** is dependent on a number of binary packages and the recommended +Mayan EDMS is dependent on a number of binary packages and the recommended way is to use a package manager such as `MacPorts `_ or `Homebrew `_. @@ -45,7 +45,7 @@ With MacPorts installed run the command: Set the Binary paths ******************** -**Mayan EDMS** by default will look in /usr/bin/ for the binary files it needs +Mayan EDMS by default will look in /usr/bin/ for the binary files it needs so either you can symlink the binaries installed via MacPorts in /opt/local/bin/ to /usr/bin/ with ... @@ -71,7 +71,7 @@ With Homebrew installed run the command: Set the Binary paths ******************** -**Mayan EDMS** by default will look in /usr/bin/ for the binary files it needs +Mayan EDMS by default will look in /usr/bin/ for the binary files it needs so either you can symlink the binaries installed via brew in /usr/local/bin/ to /usr/bin/ with ... @@ -99,8 +99,8 @@ Initialize a ``virtualenv`` to deploy the project: source venv/bin/activate pip install mayan-edms -By default **Mayan EDMS** will create a single file SQLite_ database, which makes -it very easy to start using **Mayan EDMS**. Populate the database with the +By default Mayan EDMS will create a single file SQLite_ database, which makes +it very easy to start using Mayan EDMS. Populate the database with the project's schema doing: .. code-block:: bash @@ -127,7 +127,7 @@ Production use ============== After making sure everything is running correctly, stop the ``runserver`` command. -Deploy **Mayan EDMS** using the webserver of your preference. For more information +Deploy Mayan EDMS using the webserver of your preference. For more information on deployment instructions and examples, checkout Django's official documentation on the topic https://docs.djangoproject.com/en/1.7/howto/deployment/ For a simple production deployment setup follow the instructions in the diff --git a/docs/topics/license.rst b/docs/topics/license.rst index 9240914ef1..87f20c2da0 100644 --- a/docs/topics/license.rst +++ b/docs/topics/license.rst @@ -2,7 +2,7 @@ License ======= -**Mayan EDMS** is distributed under the `Apache 2.0 License`_. +Mayan EDMS is distributed under the `Apache 2.0 License`_. The complete license terms are included below. .. _Apache 2.0 License: https://www.apache.org/licenses/LICENSE-2.0.txt diff --git a/docs/topics/permissions.rst b/docs/topics/permissions.rst index 3cff8df004..5162484836 100644 --- a/docs/topics/permissions.rst +++ b/docs/topics/permissions.rst @@ -2,7 +2,7 @@ Permissions =========== -**Mayan EDMS** provides very fine control over which actions users can +Mayan EDMS provides very fine control over which actions users can perform. Action control works by allowing ``roles``, that are composed of ``groups`` of ``users`` to be granted a ``permission`` such that the holder of that permission can exercise it throughout the entire system. diff --git a/docs/topics/signatures.rst b/docs/topics/signatures.rst index 8b3899a163..c4f3a545c3 100644 --- a/docs/topics/signatures.rst +++ b/docs/topics/signatures.rst @@ -2,7 +2,7 @@ Document signatures =================== -**Mayan EDMS** supports two types of document signatures: 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 be verified by accessing the diff --git a/docs/topics/versioning.rst b/docs/topics/versioning.rst index e96d06ea97..922c27b34e 100644 --- a/docs/topics/versioning.rst +++ b/docs/topics/versioning.rst @@ -2,7 +2,7 @@ Document versioning =================== -**Mayan EDMS** has the ability to store different versions of the same +Mayan EDMS has the ability to store different versions of the same document. A comment field is provided to allow users to summarize the new version changes in comparison with the previous one. If a new version was uploaded by mistake or such new version is no longer necessary the option to