Opened 16 years ago

Closed 16 years ago

Last modified 15 years ago

#14528 closed (fixed)

django.contrib.staticfiles documentation issues

Reported by: Brian Neal Owned by: Jannis Leidel
Component: Documentation Version: dev
Severity: Keywords: staticfiles docs
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

While reading the docs for this new app and trying to understand it, I've found some minor documentation type issues.

  1. ​Here it says AppDirectoriesFinder looks in a static directory. But ​here it says the command looks in a media directory.
  2. ​Here the 2nd paragraph just abruptly ends ("the findstatic command can help show you where").
  3. ​Here the second example has misspelled "example.com".
  4. The note under ​here has some sphinx markup mistakes ("When using the :class:AppDirectoriesFinder`")
  5. Do you want to mention the staticfiles application in ​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!

Change History (4)

comment:1 by Jannis Leidel, 16 years ago

Triage Stage: Unreviewed → Accepted

comment:2 by Jannis Leidel, 16 years ago

Owner: changed from nobody to Jannis Leidel
Status: new → assigned

comment:3 by Jannis Leidel, 16 years ago

Resolution: → fixed
Status: assigned → closed

(In [14323]) Fixed #14528 and #14538 -- Refined staticfiles documentation. Thanks, gremmie and romaniuk.

comment:3 by Jacob, 15 years ago

milestone: 1.3

Milestone 1.3 deleted

Note: See TracTickets for help on using tickets.
Back to Top