#35461: Tutorial instructions for adding django-debug-toolbar are misleading.
-------------------------------------+-------------------------------------
Reporter: dawbert | Owner: Rosana
Type: | Rufer
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
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 Rosana Rufer):
* owner: (none) => Rosana Rufer
* status: new => assigned
Comment:
I've been working on this and looking and testing the issue from different
perspectives and I've got a proposal.
Here's a summary on the thread and reasoning:
https://www.notion.so/Tutorial-instructions-for-adding-django-debug-
toolbar-are-misleading-1f1429081df4473cb5bad80790cc4176
**Total options proposed by participants:**
- **Option A** - Add the body tag in earlier pages.
- **Option A.2** - A step using template inheritance.
- **Option B** - Use a different addon as example.
- **Option C -** Suggest looking at the toolbar in /admin and explain what
needs tweaking for it to work in /polls.
**Discussion timeline:**
- **Dawbert (Reporter)** says: Following the tutorial gives wrong results
when installing django-debug-toolbar as templates need to be wrapped in
complete HTML but the tutorial doesn’t do it for brevity. Proposing
options A and B
- **Sarah** agrees Django documentation needs tweaking. Mentions the body
tag requirement is already documented in the official django-toolbar app.
- **Timothy** offers options A, A.2 and C
**My Conclusion:** It’s worth doing option C.
Reasoning:
- The main goal of this section is to learn how to add a package in the
first place and a bit of django-debug-toolbar in second place. Option C
provides both quickly in `/admin`, additionally providing a pointer on how
to see such toolbar in `/polls`
- Most people following this tutorial will trip on this step for **many
reasons*** and it’s worth improving this.
Pull Request with proposed change:
https://github.com/django/django/pull/18285
--
Ticket URL: <https://code.djangoproject.com/ticket/35461#comment:8>
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/01070190320787ea-83ff3ef7-6984-49e1-951a-d8979ffcaaf2-000000%40eu-central-1.amazonses.com.
