Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #3933 -- Updated docs/documentation.txt to reflect the lack of …

…comments on documentation. Thanks, Paul B.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4960 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 769300078887eeab71219fb0d1e9bff696159757 1 parent 0e0a1dc
Adrian Holovaty authored April 09, 2007

Showing 1 changed file with 13 additions and 21 deletions. Show diff stats Hide diff stats

  1. 34  docs/documentation.txt
34  docs/documentation.txt
@@ -42,25 +42,25 @@ On the Web
42 42
 
43 43
 The most recent version of the Django documentation lives at
44 44
 http://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,
  45
+automatically from the text files in source control. That means they reflect
  46
+the "latest and greatest" in Django -- they include the very latest
  47
+corrections and additions, and they discuss the latest Django features,
48 48
 which may only be available to users of the Django development version. (See
49 49
 "Differences between versions" below.)
50 50
 
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.
  51
+We encourage you to help improve the docs by submitting changes, corrections
  52
+and suggestions in the `ticket system`_. The Django developers actively monitor
  53
+the ticket system and use your feedback to improve the documentation for
  54
+everybody.
56 55
 
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.
  56
+Note, however, that tickets should explicitly relate to the documentation,
  57
+rather than asking broad tech-support questions. If you need help with your
  58
+particular Django setup, try the `django-users mailing list`_ or the
  59
+`#django IRC channel`_ instead.
62 60
 
  61
+.. _ticket system: http://code.djangoproject.com/simpleticket?component=Documentation
63 62
 .. _django-users mailing list: http://groups.google.com/group/django-users
  63
+.. _#django IRC channel: irc://irc.freenode.net/django
64 64
 
65 65
 In plain text
66 66
 -------------
@@ -134,14 +134,6 @@ We follow this policy:
134 134
       frozen document that says "These docs are frozen for Django version XXX"
135 135
       and links to the current version of that document.
136 136
 
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  
-
145 137
     * The `main documentation Web page`_ includes links to documentation for
146 138
       all previous versions.
147 139
 

0 notes on commit 7693000

Please sign in to comment.
Something went wrong with that request. Please try again.