#29265: Docs about static files should explain benefits of using {% static %}
template tag
------------------------------------------------+------------------------
Reporter: Ryan Govostes | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 2.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
The [https://docs.djangoproject.com/en/2.0/howto/static-files/ guide on
managing static files] says,
In your templates, either hardcode the url like
`/static/my_app/example.jpg` or, preferably, use the `static` template tag
to build the URL for the given relative path by using the configured
`STATICFILES_STORAGE` storage (this makes it much easier when you want to
switch to a content delivery network (CDN) for serving static files).
(Nit: The first "url" should be capitalized.)
The text alludes to but does not really explain that if you use a static
files storage backend that inherits from `ManifestStaticFilesStorage`, the
`static` template tag will use the name of the hashed file in production,
which enables longer-lived caches.
Since the behavior is different in debug mode, I think many users will not
even know about it, and fail to opt-in to the better caching behavior by
hard-coding paths. (The files storage backend is turned on if the
developer follows the WhiteNoise setup guide, or when using the Heroku app
template, neither of which specifically calls out the need to use
`static`.)
--
Ticket URL: <https://code.djangoproject.com/ticket/29265>
Django <https://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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/047.7b6ae05836d3e8f8f1672392242a3c04%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
