New style documentation

This commit is contained in:
Roberto Rosario
2015-05-20 21:25:17 -04:00
parent 7dd2963a4b
commit 5e4f28c83b
12 changed files with 155 additions and 116 deletions

38
docs/topics/contact.rst Normal file
View File

@@ -0,0 +1,38 @@
=======
Contact
=======
FAQ
---
* Try the :doc:`FAQ <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
<http://twitter.com/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

View File

@@ -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

View File

@@ -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/