p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[1.5.X] Fixed #19180 - Clarified policy regarding older versions of the docs. 

Backport of 5c143cb340 from master
This commit is contained in:
Tim Graham 2012-10-25 06:51:19 -04:00
parent 0887211b03
commit 84849723ad
2 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/internals/contributing/writing-documentation.txt
View File

@ -30,8 +30,9 @@ If you'd like to start contributing to our docs, get the development version of
Django from the source code repository Django from the source code repository
(see :ref:`installing-development-version`). The development version has the (see :ref:`installing-development-version`). The development version has the
latest-and-greatest documentation, just as it has latest-and-greatest code. latest-and-greatest documentation, just as it has latest-and-greatest code.
Generally, we only revise documentation in the development version, as our We also backport documentation fixes and improvements, at the discretion of the
policy is to freeze documentation for existing releases (see committer, to the last release branch. That's because it's highly advantageous
to have the docs for the last release be up-to-date and correct (see
:ref:`differences-between-doc-versions`). :ref:`differences-between-doc-versions`).
Getting started with Sphinx Getting started with Sphinx

14
docs/intro/whatsnext.txt
View File

@ -216,15 +216,13 @@ We follow this policy:
"New in version X.Y", being X.Y the next release version (hence, the one "New in version X.Y", being X.Y the next release version (hence, the one
being developed). being developed).
* Documentation for a particular Django release is frozen once the version * Documentation fixes and improvements may be backported to the last release
has been released officially. It remains a snapshot of the docs as of the branch, at the discretion of the committer, however, once a version of
moment of the release. We will make exceptions to this rule in Django is :ref:`no longer supported<backwards-compatibility-policy>`, that
the case of retroactive security updates or other such retroactive version of the docs won't get any further updates.
changes. Once documentation is frozen, we add a note to the top of each
frozen document that says "These docs are frozen for Django version XXX"
and links to the current version of that document.
* The `main documentation Web page`_ includes links to documentation for * The `main documentation Web page`_ includes links to documentation for
all previous versions. all previous versions. Be sure you are using the version of the docs
corresponding to the version of Django you are using!
.. _main documentation Web page: https://docs.djangoproject.com/en/dev/ .. _main documentation Web page: https://docs.djangoproject.com/en/dev/