Django

Code

Show
Ignore:
Timestamp:
06/17/07 17:18:54 (2 years ago)
Author:
clong
Message:

per-object-permissions: Merged to trunk [5486] NOTE: Not fully tested, will be working on this over the next few weeks.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • django/branches/per-object-permissions/docs/documentation.txt

    r3583 r5488  
    4343The most recent version of the Django documentation lives at 
    4444http://www.djangoproject.com/documentation/ . These HTML pages are generated 
    45 automatically from the text files in source control every 15 minutes. That 
    46 means they reflect the "latest and greatest" in Django -- they include the very 
    47 latest corrections and additions, and they discuss the latest Django features, 
     45automatically from the text files in source control. That means they reflect 
     46the "latest and greatest" in Django -- they include the very latest 
     47corrections and additions, and they discuss the latest Django features, 
    4848which may only be available to users of the Django development version. (See 
    4949"Differences between versions" below.) 
    5050 
    51 A key advantage of the Web-based documentation is the comment section at the 
    52 bottom of each document. This is an area for anybody to submit changes, 
    53 corrections and suggestions about the given document. The Django developers 
    54 frequently monitor the comments there and use them to improve the documentation 
    55 for everybody. 
     51We encourage you to help improve the docs by submitting changes, corrections 
     52and suggestions in the `ticket system`_. The Django developers actively monitor 
     53the ticket system and use your feedback to improve the documentation for 
     54everybody. 
    5655 
    57 We encourage you to help improve the docs: it's easy! Note, however, that 
    58 comments should explicitly relate to the documentation, rather than asking 
    59 broad tech-support questions. If you need help with your particular Django 
    60 setup, try the `django-users mailing list`_ instead of posting a comment to the 
    61 documentation. 
     56Note, however, that tickets should explicitly relate to the documentation, 
     57rather than asking broad tech-support questions. If you need help with your 
     58particular Django setup, try the `django-users mailing list`_ or the 
     59`#django IRC channel`_ instead. 
    6260 
     61.. _ticket system: http://code.djangoproject.com/simpleticket?component=Documentation 
    6362.. _django-users mailing list: http://groups.google.com/group/django-users 
     63.. _#django IRC channel: irc://irc.freenode.net/django 
    6464 
    6565In plain text 
    …… 
    9595The text documentation is written in ReST (ReStructured Text) format. That 
    9696means it's easy to read but is also formatted in a way that makes it easy to 
    97 convert into other formats, such as HTML. If you're interested, the script that 
    98 converts the ReST text docs into djangoproject.com's HTML lives at 
    99 `djangoproject.com/django_website/apps/docs/parts/build_documentation.py`_ in 
    100 the Django Subversion repository. 
     97convert into other formats, such as HTML. If you have the `reStructuredText`_ 
     98library installed, you can use ``rst2html`` to generate your own HTML files. 
    10199 
    102 .. _djangoproject.com/django_website/apps/docs/parts/build_documentation.py: http://code.djangoproject.com/browser/djangoproject.com/django_website/apps/docs/parts/build_documentation.py 
     100.. _reStructuredText: http://docutils.sourceforge.net/rst.html 
    103101 
    104102Differences between versions 
    …… 
    135133      and links to the current version of that document. 
    136134 
    137     * Once a document is frozen for a Django release, we remove comments from 
    138       that page, in favor of having comments on the latest version of that 
    139       document. This is for the sake of maintainability and usability, so that 
    140       users have one, and only one, place to leave comments on a particular 
    141       document. We realize that some people may be stuck on a previous version 
    142       of Django, but we believe the usability problems with multiple versions 
    143       of a document the outweigh the benefits. 
    144  
    145135    * The `main documentation Web page`_ includes links to documentation for 
    146136      all previous versions.