[Django] #25712: Template overview documentation is not very approachable
Django
-------------------------------+--------------------
Reporter: jbzdak | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
Template overview documentation is not very approachable for new people as
it starts with multiple pages of text, that is really about new plug-in
templates. I'm doing a course on Django (in Warsaw University Of
Technology), and I was browsing for some document that I can point
students to and say: "If you have more time before classes read that".
Pluggable template engines (and template engine configuration) are pretty
advanced subjects so ideally they should be on their own page.
I'd suggest the flowing:
* "Overview" that assumes default Django configuration, and mentions
``CONTEXT_PROCESSORS``. Also has some very brief introduction to with
something along the lines: "Engine templates are now pluggable
configuration is there" (and link to other page)
* Add page about template engine configuration and so on.
* Move information about create your own backend to it's own page (as it
is a very advanced subject --- that in dev tree covers also how to create
debug pages for not-built in engines).
--
Ticket URL: <https://code.djangoproject.com/ticket/25712>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: jbzdak | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* needs_better_patch: => 0
* needs_docs: => 0
* type: Uncategorized => Cleanup/optimization
* needs_tests: => 0
* stage: Unreviewed => Accepted
Comment:
I think I had similar concerns when reviewing Aymeric's template work, but
he convinced me the current organization wasn't completely silly.
Did you find both of these pages?
* https://docs.djangoproject.com/en/1.8/topics/templates/
* https://docs.djangoproject.com/en/1.8/ref/templates/language/
If you could propose a patch, that would be great. Otherwise, this type of
"big reorganization" ticket often languish.
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:1>
Django
Reporter: jbzdak | Owner: jbzdak
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by jbzdak):
* owner: nobody => jbzdak
* status: new => assigned
Comment:
I'll try to do this, in near future.
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:2>
Django
Reporter: jbzdak | Owner: jbzdak
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by aaugustin):
More honestly — s/completely silly/sufficiently silly to force him to
reorganize it/. I'm not very good at organizing documentation. This would
be a welcome contribution.
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:3>
Django
Reporter: Jacek Bzdak | Owner: David
Type: | Smith
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* owner: Jacek Bzdak => David Smith
* needs_better_patch: 0 => 1
* has_patch: 0 => 1
* version: 1.8 => master
Comment:
[https://github.com/django/django/pull/12789 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:4>
Django
Reporter: Jacek Bzdak | Owner: David
Type: | Smith
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by David Smith):
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:5>
Django
Reporter: Jacek Bzdak | Owner: David
Type: | Smith
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:6>
Django
Reporter: Jacek Bzdak | Owner: David
Type: | Smith
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"bb13711451157d5081c2d2a297820f6bc131ac27" bb137114]:
{{{
#!CommitTicketReference repository=""
revision="bb13711451157d5081c2d2a297820f6bc131ac27"
Fixed #25712 -- Reorganized templates docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25712#comment:7>