Anonymous avatar Anonymous committed a31fb3b

Cleaned up a bunch of minor doc stuff:

* Removed flatpages/redirects README; no other contrib apps have those.
* Cleaned up top-level README to be more readable.
* Removed outdated references to old docs (Fixes #8701)

Comments (0)

Files changed (11)

 and clean, pragmatic design.
 
 All documentation is in the "docs" directory and online at
-http://www.djangoproject.com/documentation/.  If you're just getting started,
-here's how we recommend you read the docs:
+http://docs.djangoproject.com/en/dev/. If you're just getting started, here's
+how we recommend you read the docs:
 
-    * First, read docs/install.txt for instructions on installing Django.
+    * First, read docs/intro/install.txt for instructions on installing Django.
 
-    * Next, work through the tutorials in order (docs/tutorial01.txt,
-      docs/tutorial02.txt, etc.).
+    * Next, work through the tutorials in order (docs/intro/tutorial01.txt,
+      docs/intro/tutorial02.txt, etc.).
 
-    * If you want to set up an actual deployment server, read docs/modpython.txt
-      for instructions on running Django under mod_python.
+    * If you want to set up an actual deployment server, read
+      docs/howto/deployment/modpython.txt for instructions on running Django
+      under mod_python.
 
-    * The rest of the documentation is of the reference-manual variety.
-      Read it -- and the FAQ -- as you run into problems.
+    * You'll probably want to read through the topical guides (in docs/topics)
+      next; from there you can jump to the HOWTOs (in docs/howto) for specific
+      problems, and check out the reference (docs/ref) for gory details.
 
 Docs are updated rigorously. If you find any problems in the docs, or think they
 should be clarified in any way, please take 30 seconds to fill out a ticket
 To get more help:
 
     * Join the #django channel on irc.freenode.net. Lots of helpful people
-      hang out there. Read the archives at http://simon.bofh.ms/logger/django/ .
+      hang out there. Read the archives at http://oebfare.com/logger/django/.
 
     * Join the django-users mailing list, or read the archives, at
       http://groups.google.com/group/django-users.

django/conf/global_settings.py

 FILE_UPLOAD_PERMISSIONS = None
 
 # Default formatting for date objects. See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
 DATE_FORMAT = 'N j, Y'
 
 # Default formatting for datetime objects. See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
 DATETIME_FORMAT = 'N j, Y, P'
 
 # Default formatting for time objects. See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
 TIME_FORMAT = 'P'
 
 # Default formatting for date objects when only the year and month are relevant.
 # See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
 YEAR_MONTH_FORMAT = 'F Y'
 
 # Default formatting for date objects when only the month and day are relevant.
 # See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
 MONTH_DAY_FORMAT = 'F j'
 
 # Do you want to manage transactions manually?

django/contrib/flatpages/README.TXT

-This is an optional add-on app, flatpages.
-
-For full documentation, see either of these:
-
-    * The file docs/flatpages.txt in the Django distribution
-    * http://www.djangoproject.com/documentation/flatpages/ on the Web
-
-Both have identical content.

django/contrib/redirects/README.TXT

-This is an optional add-on app, redirects.
-
-For full documentation, see either of these:
-
-    * The file django/docs/redirects.txt in the Django distribution
-    * http://www.djangoproject.com/documentation/redirects/ on the Web
-
-Both have identical content.

docs/intro/whatsnext.txt

 ----------
 
 The most recent version of the Django documentation lives at
-http://www.djangoproject.com/documentation/ . These HTML pages are generated
+http://docs.djangoproject.com/en/dev/. These HTML pages are generated
 automatically from the text files in source control. That means they reflect the
 "latest and greatest" in Django -- they include the very latest corrections and
 additions, and they discuss the latest Django features, which may only be
     * The `main documentation Web page`_ includes links to documentation for
       all previous versions.
 
-.. _main documentation Web page: http://www.djangoproject.com/documentation/
+.. _main documentation Web page: http://docs.djangoproject.com/en/dev/

docs/man/daily_cleanup.1

 .SH "SEE ALSO"
 The sessions documentation:
 .sp
-.I http://www.djangoproject.com/documentation/sessions/
+.I http://docs.djangoproject.com/en/dev/topics/http/sessions/
 
 .SH "AUTHORS/CREDITS"
 Originally developed at World Online in Lawrence, Kansas, USA. Refer to the

docs/man/django-admin.1

 Full descriptions of all these options, with examples, as well as documentation
 for the rest of the Django framework, can be found on the Django site:
 .sp
-.I http://www.djangoproject.com/documentation/
+.I http://docs.djangoproject.com/en/dev/
 .sp
 or in the distributed documentation.
 .SH "AUTHORS/CREDITS"

docs/releases/1.0-alpha-1.txt

     and redesigned with extensibility and customization in mind. Full
     documentation for the admin application is available online in the
     official Django documentation:
-    
-         http://www.djangoproject.com/documentation/admin/
+
+        :ref:`admin reference <ref-contrib-admin>`
 
 Improved Unicode handling
     Django's internals have been refactored to use Unicode throughout;
     third-party libraries and systems which may or may not handle
     Unicode gracefully. Details are available in Django's
     Unicode-handling documentation:
-    
-         http://www.djangoproject.com/documentation/unicode/
+
+         :ref:`unicode reference <ref-unicode>`
 
 An improved Django ORM
     Django's object-relational mapper -- the component which provides
     and allows both variables and larger template constructs to be
     marked as safe (requiring no escaping) or unsafe (requiring
     escaping). A full guide to this feature is in the documentation
-    for the Django template system:
-    
-        http://www.djangoproject.com/documentation/templates/#automatic-html-escaping
+    for the :ttag:`autoescape` tag.
 
 There are many more new features, many bugfixes and many enhancements
 to existing features from previous releases. The ``newforms`` library,
 Django 1.0 release, and a comprehensive list of backwards-incompatible
 changes is also available on the Django wiki for those who want to
 begin developing and testing their upgrade process:
-    
+
     http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges
 
 
 Django's online documentation also includes pointers on how to
 contribute to Django:
 
-    http://www.djangoproject.com/documentation/contributing/
+    :ref:`contributing to Django <internals-contributing>`
 
 Contributions on any level -- developing code, writing
 documentation or simply triaging tickets and helping to test proposed

docs/releases/1.0-alpha-2.txt

 Django's online documentation also includes pointers on how to
 contribute to Django:
 
-    http://www.djangoproject.com/documentation/contributing/
+    :ref:`contributing to Django <internals-contributing>`
 
 Contributions on any level -- developing code, writing
 documentation or simply triaging tickets and helping to test proposed

docs/releases/1.0-beta-2.txt

 Django's online documentation also includes pointers on how to
 contribute to Django:
 
-    http://www.djangoproject.com/documentation/contributing/
+    :ref:`contributing to Django <internals-contributing>`
 
 Contributions on any level -- developing code, writing
 documentation or simply triaging tickets and helping to test proposed

docs/releases/1.0-beta.txt

 Django's online documentation also includes pointers on how to
 contribute to Django:
 
-    http://www.djangoproject.com/documentation/contributing/
+    :ref:`contributing to Django <internals-contributing>`
 
 Contributions on any level -- developing code, writing
 documentation or simply triaging tickets and helping to test proposed
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.