diff --git a/docs/_static/api.png b/docs/_static/api.png new file mode 100644 index 0000000000..058b1115ea Binary files /dev/null and b/docs/_static/api.png differ diff --git a/docs/_static/document_view.png b/docs/_static/document_view.png new file mode 100644 index 0000000000..8c7953f27a Binary files /dev/null and b/docs/_static/document_view.png differ diff --git a/docs/_static/main.png b/docs/_static/main.png new file mode 100644 index 0000000000..0b2eb38ba6 Binary files /dev/null and b/docs/_static/main.png differ diff --git a/docs/_static/page_view.png b/docs/_static/page_view.png new file mode 100644 index 0000000000..7c9c91e028 Binary files /dev/null and b/docs/_static/page_view.png differ diff --git a/docs/_static/setup.png b/docs/_static/setup.png new file mode 100644 index 0000000000..5eb2916bb0 Binary files /dev/null and b/docs/_static/setup.png differ diff --git a/docs/_static/statistics.png b/docs/_static/statistics.png new file mode 100644 index 0000000000..3dac670691 Binary files /dev/null and b/docs/_static/statistics.png differ diff --git a/docs/_static/tools.png b/docs/_static/tools.png new file mode 100644 index 0000000000..a2272b5603 Binary files /dev/null and b/docs/_static/tools.png differ diff --git a/docs/index.rst b/docs/index.rst index 83ce223b99..8a26d9f631 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ account. App creation Translations Contributors + Screenshots Licensing FAQ Contact diff --git a/docs/releases/2.0.rst b/docs/releases/2.0.rst index a64142b9eb..6a6d2252c1 100644 --- a/docs/releases/2.0.rst +++ b/docs/releases/2.0.rst @@ -174,8 +174,8 @@ setting options. Both setting have a default of 10 seconds. Clickable preview images titles ------------------------------- -To shorten the amount of click required to access a document, document preview -image titles are clickable and will take the user straight to the document view. +To reduce the amount of clicks required to access a document, document previews +titles are now clickable and will take the user straight to the document view. Removal of eval --------------- @@ -279,16 +279,14 @@ only based on their metadata but also based on their properties. Upgrade command --------------- To reduce the steps and complexity of upgrades, the new `performupgrade` -management command was been added. All necessary apps upgrade steps will be -performed by this command. +management command was been added. All the upgrade steps will be performed +by this command. Admin changes ------------- Installation admins are no longer required to have the `superusers` or `staff` Django account flags. All setup tasks are now governed by a permission which -can be assigned to a role. This creates a clear separation between an install -administrator and the server administrator in which the installation was -performed. +can be assigned to a role. OCR functions split ------------------- @@ -352,7 +350,7 @@ Other changes * Natural key support for many models allowing database migrations using dumped data. * Separate documentation requirements file to allow for contributor who only want to work on documentation. * Centralized testing with a new management command, `runtests`. -* Addition of a tox configuration. +* Addition of a tox testing configuration. * Email test body capture. * Email subject and from values storage. * Gitlab CI support. @@ -371,6 +369,7 @@ Removals * Removal of the DOCUMENT_RESTRICTIONS_OVERRIDE permission. * Removed the page_label field. * Removal of custom HTTP 505 error view. + Upgrading from a previous version --------------------------------- @@ -448,15 +447,62 @@ Backward incompatible changes Bugs fixed or issues closed =========================== -* `issue #33 `_ Update to Django 1.7 -* `issue #59 `_ New bootstrap based UI -* `issue #60 `_ Backport class based navigation code from the unstable branch -* `issue #62 `_ Simplify and reduce code in templates -* `issue #67 `_ Python 3 compatibility: Update models __unicode__ methdo to __str__ methods (using Django's six library) -* `issue #121 `_ Twitter Bootstrap theme for Mayan EDMS -* `issue #155 `_ Header does not fit list on documents/list on small screens (laptop) -* `issue #170 `_ Remove use of python-hkp -* `issue #182 `_ Reorganize signal processors +* `GitHub issue #33 `_ Update to Django 1.7 +* `GitHub issue #59 `_ New bootstrap based UI +* `GitHub issue #60 `_ Backport class based navigation code from the unstable branch +* `GitHub issue #62 `_ Simplify and reduce code in templates +* `GitHub issue #67 `_ Python 3 compatibility: Update models __unicode__ methdo to __str__ methods (using Django's six library) +* `GitHub issue #121 `_ Twitter Bootstrap theme for Mayan EDMS +* `GitHub issue #155 `_ Header does not fit list on documents/list on small screens (laptop) +* `GitHub issue #170 `_ Remove use of python-hkp +* `GitHub issue #182 `_ Reorganize signal processors +* `GitLab issue #131 `_ error on initialsetup: GPG initialization error +* `GitLab issue #135 `_ Add document indexing filesystem mirroring +* `GitLab issue #141 `_ Merge common and main app +* `GitLab issue #142 `_ New authentication app +* `GitLab issue #145 `_ Convert document tags to user RGB value for code instead of predetermined choices +* `GitLab issue #150 `_ Add 'trash can' support +* `GitLab issue #151 `_ Add support for data retention policies +* `GitLab issue #152 `_ JSON API 500 error +* `GitLab issue #154 `_ /documents API endpoint should return document pk +* `GitLab issue #155 `_ Remove unused document page label field +* `GitLab issue #156 `_ Remove post OCR language cleanup +* `GitLab issue #158 `_ Django REST Swagger not working +* `GitLab issue #159 `_ Error during template rendering on /document/folder/add with non-admin user +* `GitLab issue #160 `_ Add audit logging +* `GitLab issue #163 `_ Removal of the compressed file support +* `GitLab issue #164 `_ Keep fancybox prev & next buttons enabled all the time +* `GitLab issue #167 `_ Add workflow completion number to states +* `GitLab issue #168 `_ Add field to store last error of source during execution +* `GitLab issue #171 `_ tesseract fails with german language (wrong abbreviation) +* `GitLab issue #173 `_ Add post_document_upload signal +* `GitLab issue #174 `_ Bootstrap UI with master branch +* `GitLab issue #176 `_ Replace default email domain +* `GitLab issue #177 `_ Multi page tiff preview is not working +* `GitLab issue #178 `_ Add separate missing optional metadata and missing required metadata tools +* `GitLab issue #181 `_ Move task <-> queue assignment to apps.py +* `GitLab issue #182 `_ Document tags widget is not permissions aware +* `GitLab issue #183 `_ Separate metadata validators into: validators and parsers +* `GitLab issue #184 `_ Move literals in checkouts apps.py and tasks.py to literals.py +* `GitLab issue #186 `_ Scheduled task to delete all document stubs of more than X age. +* `GitLab issue #187 `_ Add tests for multi page tiff files +* `GitLab issue #189 `_ Use transient queues +* `GitLab issue #190 `_ Bump API version number +* `GitLab issue #192 `_ Use local model for document comments +* `GitLab issue #197 `_ Add continuous integration that is compatible with Gitlab +* `GitLab issue #201 `_ Untranslated items +* `GitLab issue #202 `_ AutoAdminSingleton matching query does not exist. +* `GitLab issue #203 `_ KeyError at /sources/upload/document/new/interactive/ +* `GitLab issue #204 `_ Problems to add required metadata after changin the document type +* `GitLab issue #216 `_ Add default_app_config value to each app +* `GitLab issue #223 `_ [Documents] Trigger event_document_type_change on the model not on the view +* `GitLab issue #227 `_ decoder zip not available +* `GitLab issue #228 `_ Attribute error when trying to attach a tag for a user with inadequate permissions +* `GitLab issue #229 `_ Attribute error when a user tries to download a document - version 2.0.0b2 +* `GitLab issue #230 `_ No option to create new document version even though user given permission in document ACL +* `GitLab issue #231 `_ User shown option to upload new version of a document even though it is blocked by checkout - v2.0.0b2 +* `GitLab issue #233 `_ Available users instead of available groups +* `GitLab issue #237 `_ Forcefully checking in a document by a user without adequate permissions throws out an error .. _PyPI: https://pypi.python.org/pypi/mayan-edms/ diff --git a/docs/topics/development.rst b/docs/topics/development.rst index 4d85314a8c..977a4b2358 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -357,9 +357,9 @@ Likewise, to see the debug output of the ``tags`` app, just add the following in Documentation ------------- -The documentation is written in `reStructured Text`_ format and resides in the -``docs`` directory. In order to build it, you will first need to install the -documentation editing dependencies (Sphinx_, etc):: +The documentation is written in `reStructured Text`_ format, processed with +Sphinx_, and resides in the ``docs`` directory. In order to build it, you will +first need to install the documentation editing dependencies with:: pip install -r requirements/documentation.txt @@ -368,10 +368,11 @@ from the **docs** directory:: make livehtml -The ``docs/_build/html`` directory will then contain an HTML version of the -documentation. +The generated documentation can be viewed by browsing to http://127.0.0.1:8000 +or by browsing to the ``docs/_build/html`` directory. -You can also generate the documentation in formats other than HTML. +You can also generate the documentation in formats other than HTML. Consult the +Sphinx_ documentation for more details. .. _`reStructured Text`: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx.pocoo.org diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 32511c51eb..9cf7bcf04d 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -19,3 +19,4 @@ Introductions to all the key parts of **Mayan EDMS** you'll need to know: smart_links tags file_storage + screenshots diff --git a/docs/topics/screenshots.rst b/docs/topics/screenshots.rst new file mode 100644 index 0000000000..8d9d1275f5 --- /dev/null +++ b/docs/topics/screenshots.rst @@ -0,0 +1,64 @@ +=========== +Screenshots +=========== + +.. figure:: /_static/main.png + :figwidth: 40% + :scale: 30 % + :alt: Home screen + :align: left + + Home screen + +.. figure:: /_static/page_view.png + :figwidth: 40% + :scale: 30 % + :alt: Page view + :align: right + + Page view + + +.. figure:: /_static/document_view.png + :figwidth: 40% + :scale: 30 % + :alt: Document view + :align: left + + Document view + + +.. figure:: /_static/api.png + :figwidth: 40% + :scale: 30 % + :alt: REST API + :align: right + + REST API + + +.. figure:: /_static/tools.png + :figwidth: 40% + :scale: 30 % + :alt: Tools + :align: left + + Tools + + +.. figure:: /_static/setup.png + :figwidth: 40% + :scale: 30 % + :alt: Setup + :align: right + + Setup + + +.. figure:: /_static/statistics.png + :figwidth: 40% + :scale: 30 % + :alt: Statistics + :align: left + + Statistics