Update documentation.

This commit is contained in:
Roberto Rosario
2015-09-24 01:50:51 -04:00
parent c9b981f07a
commit bef6bbaf3e
5 changed files with 26 additions and 23 deletions
+1
View File
@@ -1,6 +1,7 @@
2.0 (2015-10-xx) 2.0 (2015-10-xx)
================ ================
- New source homepage: https://gitlab.com/mayan-edms/mayan-edms
- Update to Django 1.7 - Update to Django 1.7
- New Bootstrap Frontend UI - New Bootstrap Frontend UI
- Easier theming and rebranding - Easier theming and rebranding
+1 -1
View File
@@ -34,5 +34,5 @@ Report bugs with **Mayan EDMS** or search existing ones using Github's `ticket t
.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/ .. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/
.. _post a question: 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 .. _ticket tracker: https://gitlab.com/mayan-edms/mayan-edms/issues
.. _Gmane: http://news.gmane.org/gmane.comp.python.django.mayan-edms .. _Gmane: http://news.gmane.org/gmane.comp.python.django.mayan-edms
+9 -8
View File
@@ -30,7 +30,6 @@ why things are the way they are in **Mayan EDMS**.
- Each app is as independent and self contained as possible. Exceptions, the basic requirements: navigation, permissions, common, main. - Each app is as independent and self contained as possible. Exceptions, the basic requirements: navigation, permissions, common, main.
- If an app is meant to be used by more than one other app it should be as generic as possible in regard to the project and another app will bridge the functionality. - If an app is meant to be used by more than one other app it should be as generic as possible in regard to the project and another app will bridge the functionality.
- Example: the acls app is app agnostic, document_acls connects the acls app with the documents app.
- Example: since indexing (document_indexing) only applies to documents, the app is specialized and dependant on the documents app. - Example: since indexing (document_indexing) only applies to documents, the app is specialized and dependant on the documents app.
@@ -189,7 +188,7 @@ Source Control
The project is publicly accessible, hosted and can be cloned from **GitLab** using:: The project is publicly accessible, hosted and can be cloned from **GitLab** using::
$ git clone git://gitlab.com/mayan-edms/mayan-edms.git $ git clone https://gitlab.com/mayan-edms/mayan-edms.git
Git branch structure Git branch structure
@@ -286,8 +285,10 @@ Debugging
--------- ---------
**Mayan EDMS** makes extensive use of Django's new `logging capabilities`_. **Mayan EDMS** makes extensive use of Django's new `logging capabilities`_.
To enable debug logging for the ``documents`` app for example add the following By default debug logging for all apps is turned on. If you wish to customize
lines to your ``settings_local.py`` file:: how logging is managed turn off automatic logging by setting
`COMMON_AUTO_LOGGING` to False and add the following lines to your
``settings/local.py`` file::
LOGGING = { LOGGING = {
'version': 1, 'version': 1,
@@ -372,7 +373,7 @@ This is the sequence of step I use to produce an installable package:
$ rm dist -R $ rm dist -R
2. Generate the packaged version (will produce dist/mayan-edms-1.1.1.tar.gz):: 2. Generate the packaged version (will produce dist/mayan-edms-2.0.0.tar.gz)::
$ python setup.py sdist $ python setup.py sdist
@@ -381,7 +382,7 @@ This is the sequence of step I use to produce an installable package:
$ cd /tmp $ cd /tmp
$ virtualenv venv $ virtualenv venv
$ source venv/bin/activate $ source venv/bin/activate
$ pip install <path of the Git repository>/dist/mayan-edms-1.1.1.tar.gz $ pip install <path of the Git repository>/dist/mayan-edms-2.0.0.tar.gz
$ mayan-edms.py initialsetup $ mayan-edms.py initialsetup
$ mayan-edms.py runserver $ mayan-edms.py runserver
@@ -395,13 +396,13 @@ Wheel package
2. Create wheel package using the source file package (Until issue #99 of wheel is fixed: https://bitbucket.org/pypa/wheel/issue/99/cannot-exclude-directory):: 2. Create wheel package using the source file package (Until issue #99 of wheel is fixed: https://bitbucket.org/pypa/wheel/issue/99/cannot-exclude-directory)::
$ pip wheel --no-index --no-deps --wheel-dir dist dist/mayan-edms-1.1.1.tar.gz $ pip wheel --no-index --no-deps --wheel-dir dist dist/mayan-edms-2.0.0.tar.gz
3. Do a test install:: 3. Do a test install::
$ cd /tmp $ cd /tmp
$ virtualenv venv $ virtualenv venv
$ source venv/bin/activate $ source venv/bin/activate
$ pip install <path of the Git repository>/dist/mayan_edms-1.1.1-py2-none-any.whl $ pip install <path of the Git repository>/dist/mayan_edms-2.0.0-py2-none-any.whl
$ mayan-edms.py initialsetup $ mayan-edms.py initialsetup
$ mayan-edms.py runserver $ mayan-edms.py runserver
+3 -3
View File
@@ -26,7 +26,7 @@ Features
* Dynamic default values for metadata. * Dynamic default values for metadata.
* Metadata fields can have an initial value, which can be static or determined by an user provided Python code snippet. * Metadata fields can have an initial value, which can be static or determined by an user provided template code snippet.
* Documents can be uploaded from different sources. * Documents can be uploaded from different sources.
@@ -38,7 +38,7 @@ Features
* Previews for a great deal of image formats. * Previews for a great deal of image formats.
* **Mayan EDMS** provides different file conversion backends with different levels of functionality and requirements to adapt to different deployment environments. * **Mayan EDMS** provides document image preview generation for many popular file formats.
* Full text searching. * Full text searching.
@@ -67,7 +67,7 @@ Features
* Multilingual user interface. * Multilingual user interface.
* **Mayan EDMS** being written using the Django_ framework, can be translated to practically any language spoken in the world. * **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 Transifex_. For a list of translated languages have a look at the Transifex_ project location.
* Multilingual OCR support. * Multilingual OCR support.
+12 -11
View File
@@ -2,15 +2,16 @@
Translations Translations
============ ============
Translations are handled online via the **Transifex** website: https://www.transifex.com/projects/p/mayan-edms/. Translations are handled online via the **Transifex** website:
To create a translation team for a new language or contribute to an already https://www.transifex.com/projects/p/mayan-edms/. To create a translation team
existing language translation, create a **Transifex** account and contact for a new language or contribute to an already existing language translation,
the team coordinator of the respective language in which you are interested. create a **Transifex** account and contact the team coordinator of the
respective language in which you are interested.
Feel free to open translation issues inside **Transifex** itself if you have a question Feel free to open translation issues inside **Transifex** itself if you have a
about the usage or meaning of a source text string. If you open a translation issue, question about the usage or meaning of a source text string. If you open a
it will be your resposibility to close it after you get an answers that satisfies translation issue, it will be your resposibility to close it after you get an
your question. Administrator will not close new issues as they have no way to determine answers that satisfies your question. Administrator will not close new issues
if your question has been properly answered. However to avoid cluter, answered as they have no way to determine if your question has been properly answered.
questions will be scanned periodically and closed if not activity is observed However to avoid cluter, answered questions will be scanned periodically and
from the original poster. closed if not activity is observed from the original poster.