diff --git a/docs/_static/logo_pyramid_only.png b/docs/_static/logo_pyramid_only.png new file mode 100644 index 0000000000..4a09190392 Binary files /dev/null and b/docs/_static/logo_pyramid_only.png differ diff --git a/docs/_templates/donate.html b/docs/_templates/donate.html new file mode 100644 index 0000000000..79a151fb76 --- /dev/null +++ b/docs/_templates/donate.html @@ -0,0 +1,4 @@ +

Donate

+

+Help support further improvements and development by donating on: Patreon +

diff --git a/docs/conf.py b/docs/conf.py index 01fabc764a..920bb4785f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,6 @@ # -*- coding: utf-8 -*- +from __future__ import unicode_literals + # # Mayan EDMS documentation build configuration file, created by # sphinx-quickstart on Fri Aug 19 05:13:38 2011. @@ -43,7 +45,7 @@ source_suffix = '.rst' # source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'contents' +master_doc = 'index' # General information about the project. project = mayan.__title__ @@ -98,7 +100,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -185,8 +187,8 @@ htmlhelp_basename = 'MayanEDMSdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'MayanEDMS.tex', u'Mayan EDMS Documentation', - u'Roberto Rosario', 'manual'), + ('index', 'MayanEDMS.tex', 'Mayan EDMS Documentation', + mayan.__author__, 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -218,6 +220,29 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'mayanedms', u'Mayan EDMS Documentation', - [u'Roberto Rosario'], 1) + ('index', 'mayanedms', 'Mayan EDMS Documentation', + [mayan.__author__], 1) ] + + +# -- Custom options +import alabaster + +html_theme_path = [alabaster.get_path()] +extensions = ['alabaster'] +html_theme = 'alabaster' +html_sidebars = { + '**': [ + 'about.html', 'navigation.html', 'searchbox.html', 'donate.html', + ] +} +html_theme_options = { + 'description': 'Free Open Source Electronic Document Management System', + 'github_user': 'mayan-edms', + 'github_repo': 'mayan-edms', + 'travis_button': True, + 'gratipay_user': 'rosarior', + 'github_banner': True, +} + +html_logo = '_static/logo_pyramid_only.png' diff --git a/docs/contents.rst b/docs/contents.rst deleted file mode 100644 index d8cfcbbc36..0000000000 --- a/docs/contents.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _contents: - -======== -Contents -======== - -.. toctree:: - :hidden: - - index - -.. toctree:: - :maxdepth: 3 - - topics/index - releases/index diff --git a/docs/index.rst b/docs/index.rst index e9bbde7e9c..e9599b0eb2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,60 +1,41 @@ -.. _index: +Welcome to Mayan EDMS! +====================== -======================== -Mayan EDMS documentation -======================== +**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. -.. rubric:: `Open source`_ `electronic document management system`_. +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: -Getting help -============ +.. code-block:: bash -* 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_. -* Report bugs with **Mayan EDMS** using Github's `ticket tracker`_. -* Try the :doc:`FAQ ` -- it's got answers to many common questions. + $ 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 + $ virtualenv venv + $ source venv/bin/activate + $ pip install mayan-edms + $ mayan-edms.py initialsetup + $ mayan-edms.py runserver +Point your browser to 127.0.0.1:8000 and use the automatically created admin +account. -First steps -=========== +.. toctree:: + :hidden: - :doc:`Features ` | - :doc:`Installation ` | - :doc:`Getting started ` - -Understanding Mayan EDMS -======================== - - :doc:`File storage ` | - :doc:`Permission system ` | - :doc:`Transformations ` | - :doc:`Document versioning ` | - :doc:`Document signatures ` | - :doc:`Indexes ` | - :doc:`Smart links ` | - :doc:`Tags ` | - -Release notes -============= - - :doc:`Release notes and upgrading instructions ` - -For developers -============== - - :doc:`Development ` - -Credits -======= - - :doc:`Contributors ` | - :doc:`Licensing ` + Features + Installation + Getting started + Release notes and upgrading instructions + Understanding Mayan EDMS + Development + Contributors + Licensing + FAQ + Contact .. _Django: http://www.djangoproject.com/ -.. _Gmane: http://news.gmane.org/gmane.comp.python.django.mayan-edms -.. _Open source: http://en.wikipedia.org/wiki/Open_source -.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/ -.. _electronic document management system: https://en.wikipedia.org/wiki/Document_management_system -.. _post a question: http://groups.google.com/group/mayan-edms -.. _ticket tracker: https://github.com/mayan-edms/mayan-edms/issues +.. _Free Open Source: http://en.wikipedia.org/wiki/Open_source +.. _Electronic Document Management System: https://en.wikipedia.org/wiki/Document_management_system +.. _Apache 2.0 License: https://www.apache.org/licenses/LICENSE-2.0.txt diff --git a/docs/releases/0.12.rst b/docs/releases/0.12.rst index 7452447a1d..67f4f20f1e 100644 --- a/docs/releases/0.12.rst +++ b/docs/releases/0.12.rst @@ -49,14 +49,14 @@ ACL support A more in-depth explanation of how this new ACL system can be found in the :doc:`3 tier access control <../topics/permissions>` section of the permissions chapter. - + * Default class ACL support. Administrators can setup the access control lists that new documents, folders and tags will automatically inheric when created. Aside from asigning permission to users, groups and roles to specific objects, there is a special user called `Creator`, use to allow the access control list that the actual creator of an object will - inherit. - + inherit. + Anonymous user support ~~~~~~~~~~~~~~~~~~~~~~ Anonymous user support is a two tier function, first is the addition of @@ -78,32 +78,31 @@ Usability improvements erases the previous one. * Usability improvement in the role member's add/removal form, by using HTML's option groups tag property - + 2 Step download process ~~~~~~~~~~~~~~~~~~~~~~~ The code for downloading single and multiple document and document versions has been merged with compression support also added. This allows for the download of documents in their original format or compressed and well as -the download of several documents in a single compressed file. +the download of several documents in a single compressed file. Customizable GPG home directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Addition of the :setting:`SIGNATURES_GPG_HOME` configuration option to let +Addition of the :setting:`SIGNATURES_GPG_HOME` configuration option to let administrators set **Mayan EDMS**'s GPG instance home directory, used to store keyrings and other GPG configuration files. Out of process bulk uploading ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A management command has been added to help upload a large number of documents -from a compressed file. For information about this new feature check the -:doc:`Initial data loading <../topics/initial_import>` chapter. +from a compressed file. For information about this new feature check the Initial data loading chapter. + - Out of process user import ~~~~~~~~~~~~~~~~~~~~~~~~~~ A management command has been added to import a large number users -from a CSV file. More information about this new feature can also be found -in the :doc:`Initial data loading <../topics/initial_import>` chapter. +from a CSV file. More information about this new feature can also be found +in the Initial data loading chapter. Refactored document indexing @@ -123,7 +122,7 @@ mirrored on disk. Help shape Mayan EDMS's future ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Included in this version is a small feedback application, found under the +Included in this version is a small feedback application, found under the ``About`` main menu, where users by just answering some questions can 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 @@ -169,7 +168,7 @@ When the following message appears If you're unsure, answer 'no'. Type 'yes' to continue, or 'no' to cancel: - + Type ``yes`` and press **Enter** And continue migrating database schema with:: @@ -213,7 +212,7 @@ Bugs fixed ========== * Issue #17, special thanks to Dave Herring for all the help including access to a machine suffering with the issue, and to Sergei Glita for - his research and eventual find of the core cause. + his research and eventual find of the core cause. * Statistics fixes. * Fixed get_image_cache_name regression in the OCR app. @@ -221,12 +220,12 @@ Stuff removed ============= * Support for Celery and Sentry has been drop for now. -* Removed the 'db_index' argument from Text fields definition and +* Removed the 'db_index' argument from Text fields definition and migrations as it was causing error messages for MySQL users, thanks to Sergei Glita for reporting this one. * Configuration options removed: - + * OCR_CACHE_URI * DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_PATH - Use the newest :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING` * DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE - Use the newest :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING` - + diff --git a/docs/releases/1.1.1.rst b/docs/releases/1.1.1.rst index f3a72954d0..d8bcbd1c5f 100644 --- a/docs/releases/1.1.1.rst +++ b/docs/releases/1.1.1.rst @@ -11,7 +11,6 @@ Update to Django 1.6.11 ~~~~~~~~~~~~~~~~~~~~~~~ The required version of Django has been updated to version 1.6.11_. - Minor changes ~~~~~~~~~~~~~ - Fix make_dist.sh script @@ -23,9 +22,24 @@ Minor changes - Removal of installation statistics gathering - Remove unused folder tag - Fix usage of ugettext to ugettext_lazy +- Increase size of the lock name field +- New style documentation Upgrading from a previous version ================================= + +Using PIP +~~~~~~~~~ + +Type in the console:: + + $ pip install mayan-edms==1.1.1 + +the requirements will also be updated. + +Using Git +~~~~~~~~~ + If you installed Mayan EDMS by cloning the Git repository issue the commands:: $ git reset --hard HEAD @@ -37,6 +51,9 @@ Next upgrade/add the new requirements:: $ pip install --upgrade -r requirements.txt +Common steps +~~~~~~~~~~~~ + Add new static media:: $ mayan-edms.py collectstatic --noinput diff --git a/docs/releases/index.rst b/docs/releases/index.rst index 6704ec6953..c51bfdcecb 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -17,20 +17,13 @@ Final releases 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. -1.1 release +1.0 series ----------- .. toctree:: :maxdepth: 1 - 1.1 1.1.1 - - -1.0 release ------------ -.. toctree:: - :maxdepth: 1 - + 1.1 1.0 0.13 release diff --git a/docs/topics/contact.rst b/docs/topics/contact.rst new file mode 100644 index 0000000000..79c277d06d --- /dev/null +++ b/docs/topics/contact.rst @@ -0,0 +1,38 @@ +======= +Contact +======= + + +FAQ +--- + +* Try the :doc:`FAQ ` -- it's got answers to many common questions. + +Mailing list +------------ + +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. +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 +`_, which is used for announcements and occasional +related news tidbits. + + +Bugs/ticket tracker +------------------- + +Report bugs with **Mayan EDMS** or search existing ones using Github's `ticket tracker`_. + + +.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/ +.. _post a question: http://groups.google.com/group/mayan-edms +.. _ticket tracker: https://github.com/mayan-edms/mayan-edms/issues +.. _Gmane: http://news.gmane.org/gmane.comp.python.django.mayan-edms diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 0cae551fbc..f39b871712 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -1,23 +1,16 @@ -Using Mayan EDMS -================ +Understanding Mayan EDMS +======================== Introductions to all the key parts of Mayan EDMS you'll need to know: .. toctree:: :maxdepth: 1 - contributors - development - faq - features file_storage - getting_started - indexes - installation - license permissions - signatures - smart_links - tags transformations versioning + signatures + indexes + smart_links + tags diff --git a/docs/topics/installation.rst b/docs/topics/installation.rst index 0a43c02cf4..88b6a60dde 100644 --- a/docs/topics/installation.rst +++ b/docs/topics/installation.rst @@ -118,8 +118,8 @@ to /usr/bin/ with ... GM_PATH = '/usr/local/bin/gm' LIBREOFFICE_PATH = '/Applications/LibreOffice.app/Contents/MacOS/soffice' -Production use --------------- +Testing the install +------------------- To create a custom settings file for **Mayan EDMS**, create a Python (.py) file in the directory: venv/lib/python2.7/site-packages/mayan/settings/ with the following basic content:: @@ -136,7 +136,12 @@ To test your settings launch **Mayan EDMS** using:: $ mayan-edms.py runserver --settings=mayan.settings.my_settings -After making sure everything is running correctly, stop the runserver command. +Note: Background tasks and scheduled tasks will not run when using the test server. + +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 on deployment instructions and examples, checkout Django's official documentation on the topic https://docs.djangoproject.com/en/1.6/howto/deployment/ diff --git a/mayan/__init__.py b/mayan/__init__.py index 1413b49ccf..4ba68a4e72 100644 --- a/mayan/__init__.py +++ b/mayan/__init__.py @@ -5,4 +5,4 @@ __version__ = '1.1.1' __build__ = 0x010101 __author__ = 'Roberto Rosario' __license__ = 'Apache 2.0' -__copyright__ = 'Copyright 2011 Roberto Rosario' +__copyright__ = 'Copyright 2011-2015 Roberto Rosario'