Change the documentation structure to be more like Django's one

This commit is contained in:
Roberto Rosario
2012-01-24 01:51:12 -04:00
parent a63b6e2039
commit c48d158581
3 changed files with 105 additions and 0 deletions

View File

@@ -40,6 +40,7 @@ Contents
features
requirements
installation
releases/index
settings
updates
development

73
docs/releases/0.12.rst Normal file
View File

@@ -0,0 +1,73 @@
========================
Mayan EDMS 0.12 release notes
========================
*February 2012*
Welcome to Mayan EDMS 0.12!
This release commemorates **Mayan EDMS** first aniversary!
Overview
========
**Mayan EDMS** focus has mostly been on improving the code 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
level permissions, with this new system being applied to documents,
folder, tags and smart links.
What's new in Django 1.3
========================
ACL support
~~~~~~~~~~~
Anonymous user support
~~~~~~~~~~~~~~~~~~~~~~
Italian translation
~~~~~~~~~~~~~~~~~~~
Usability improvements
~~~~~~~~~~~~~~~~~~~~~~
Upgrading
=========
::
$ ./manage.py syncdb
$ ./manage.py migrate permissions 0001 --fake
$ ./manage.py migrate permissions
When the following message appears
``The following content types are stale and need to be deleted:
permissions | permission
Any objects related to these content types by a foreign key will also
be deleted. Are you sure you want to delete these content types?
If you're unsure, answer 'no'.
Type 'yes' to continue, or 'no' to cancel:``
Types ``yes`` and press **Enter**
::
$ ./manage.py migrate documents
$ ./manage.py migrate document_signatures
Backward incompatible changes
=============================
The permission system has been completely reworked so sadly this is a
place where even data migration can't help and the permissions assigned
to roles will be lost during the upgrade to version 0.12. Users, groups
and roles will be preserved only permissions need to be assigned again,
so write down your role permission setup before upgrading.

31
docs/releases/index.rst Normal file
View File

@@ -0,0 +1,31 @@
=============
Release notes
=============
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
all the backwards-incompatible changes and deprecated features for
each 'final' release from the one after your current **Mayan EDMS** version,
up to and including the new version.
Final releases
==============
0.12 release
-----------
.. toctree::
:maxdepth: 1
0.12
0.11 release
-----------
.. toctree::
:maxdepth: 1
0.11.1
0.11