#14528: django.contrib.staticfiles documentation issues
------------------------------+---------------------------------------------
 Reporter:  gremmie           |       Owner:  nobody    
   Status:  new               |   Milestone:  1.3       
Component:  Documentation     |     Version:  SVN       
 Keywords:  staticfiles docs  |       Stage:  Unreviewed
Has_patch:  0                 |  
------------------------------+---------------------------------------------
 While reading the docs for this new app and trying to understand it, I've
 found some minor documentation type issues.

  1. [http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles
 /#staticfiles-finders Here] it says AppDirectoriesFinder looks in a {{{
 static }}} directory. But
 [http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#django-
 admin-collectstatic here] it says the command looks in a {{{ media }}}
 directory.
  1. [http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#django-
 admin-collectstatic Here] the 2nd paragraph just abruptly ends ("the
 findstatic command can help show you where").
  1. [http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles
 /#staticfiles-url Here] the second example has misspelled "example.com".
  1. The note under
 [http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles
 /#staticfiles-finders here] has some sphinx markup mistakes ("When using
 the :class:AppDirectoriesFinder`")
  1. Do you want to mention the staticfiles application in
 [http://docs.djangoproject.com/en/1.2/howto/static-files/#module-
 django.views.static this section] of the docs?

 And maybe this is out of scope for a typo only ticket, but I for one would
 appreciate some guidance or background on this application and how it
 relates to MEDIA_ROOT and MEDIA_URL. Maybe stress that MEDIA_URL and
 MEDIA_ROOT are for files users upload, while staticfiles handles static
 media for apps (assuming I've correctly interpreted the purpose
 correctly). I assume this app is trying to solve the problem of getting
 app media mixed up with user uploaded media?

 Thanks!

-- 
Ticket URL: <http://code.djangoproject.com/ticket/14528>
Django <http://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Reply via email to