Re: [Django] #34499: In tutorial part08, Django debug toolbar shows up in admin site but not in public site
Django
public site
-------------------------------------+-------------------------------------
Reporter: lucaremdev | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by lucaremdev:
Old description:
> If you are a newbie like me and follow exactly the django tutorial, when
> you get to [https://docs.djangoproject.com/en/4.2/intro/tutorial08/ part
> 8], then you don't understand why Django debug toolbar shows up in admin
> site but not in public site.
> As mentioned on django discord
> [https://discord.com/channels/856567261900832808/856567261900832811/1096783278154985572
> here], the solution consists in making each template a full HTML document
> with a body element for the debug toolbar to show up in the public site
> as well.
>
> So, you could either show full HTML documents with body elements from the
> beginning in the tutorial,
> or
> in [https://docs.djangoproject.com/en/4.2/intro/tutorial08/#installing-
> django-debug-toolbar this part of the tutorial], after this sentence
> "Once installed, you should be able to see the DjDT “handle” on the right
> side of the browser window when you refresh the polls application.", you
> could add something like: "note that for the django debug toolbar to show
> up correctly, you should properly make each template a full HTML
> document, as we mentioned it to be best practice earlier".
>
> These are just suggestions of course! Do as it seems better for the whole
> community!
> And thank you anyway =)
New description:
If you are a newbie like me and follow exactly the django tutorial, when
you get to [https://docs.djangoproject.com/en/4.2/intro/tutorial08/ part
8], then you don't understand why Django debug toolbar shows up in admin
site (http://127.0.0.1:8000/admin/) but not in public site
(http://127.0.0.1:8000/polls/).
As mentioned on django discord
[https://discord.com/channels/856567261900832808/856567261900832811/1096783278154985572
here], the solution consists in making each template a full HTML document
with a body element for the debug toolbar to show up in the public site as
well.
So, you could either show full HTML documents with body elements from the
beginning in the tutorial,
or
in [https://docs.djangoproject.com/en/4.2/intro/tutorial08/#installing-
django-debug-toolbar this part of the tutorial], after this sentence "Once
installed, you should be able to see the DjDT “handle” on the right side
of the browser window when you refresh the polls application.", you could
add something like: "note that for the django debug toolbar to show up
correctly, you should properly make each template a full HTML document, as
we mentioned it to be best practice earlier".
These are just suggestions of course! Do as it seems better for the whole
community!
And thank you anyway =)
--
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
public site
-------------------------------------+-------------------------------------
Reporter: lucaremdev | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by lucaremdev:
Old description:
> If you are a newbie like me and follow exactly the django tutorial, when
> you get to [https://docs.djangoproject.com/en/4.2/intro/tutorial08/ part
> 8], then you don't understand why Django debug toolbar shows up in admin
New description:
django-debug-toolbar this part of the tutorial], after the sentence
''"Once installed, you should be able to see the DjDT “handle” on the
right side of the browser window when you refresh the polls
application."'', you could add something like: ''"note that for the django
debug toolbar to show up correctly, you should properly make each template
a full HTML document, as we mentioned it to be best practice earlier"''.
These are just suggestions of course! Do as it seems better for the whole
community!
And thank you anyway =)
--
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:6>
Django
Old description:
New description:
The aforesaid "mentioned earlier" is
[https://docs.djangoproject.com/en/4.2/intro/tutorial03/#write-views-that-
actually-do-something here] in the "note" section, when said: ''"To make
the tutorial shorter, all template examples use incomplete HTML. In your
own projects you should use complete HTML documents."''
These are just suggestions of course! Do as it seems better for the whole
community!
And thank you anyway =)
--
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:7>
Django
public site
-------------------------------------+-------------------------------------
Reporter: lucaremdev | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by idobrodushniy):
I think such things may happen in any section and it is really hard to
keep the track of all the updates that would lead to such a potential room
for an issue as soon as new releases come.
What I think could be nice is:
1. Add the "note" section with a message that HTML snippets may be
incomplete at the beginning of every part where it contains new HTML
updates.
2. A link to a code source repo attached at the end of every section
demonstrating the state of the code at the end of every part of the
tutorial.
Curious to hear what others think.
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:8>
Django
public site
-------------------------------------+-------------------------------------
Reporter: lucaremdev | Owner: nobody
Cleanup/optimization |
Component: Documentation | Version: 4.2
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => wontfix
Comment:
Thanks for the ticket, however we would very much like to avoid describing
caveats in 3rd party packages. I don't want to open Pandora's box by
accepting this. Django Debug Toolbar here is just an example of a useful
3rd party package that we want to keep as generic as possible. I hope that
makes sense.
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:9>
Django
public site
-------------------------------------+-------------------------------------
Reporter: lucaremdev | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by lucaremdev):
Replying to [comment:9 Mariusz Felisiak]:
> Thanks for the ticket, however we would very much like to avoid
describing caveats in 3rd party packages. I don't want to open Pandora's
box by accepting this. Django Debug Toolbar here is just an example of a
useful 3rd party package that we want to keep as generic as possible. I
hope that makes sense.
Yes, sure, I understand, that does make sense. Thank you for your answer,
and have a very nice day!
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:10>
Django
public site
-------------------------------------+-------------------------------------
Reporter: lucaremdev | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by rytilahti):
First of all, thanks for the great tutorial! I just finished going it
through in a one sitting and was enough confused about this problem to
start looking into getting it fixed.
For a simple solution, maybe the wording should be changed to point the
reader to test it on the admin page (i.e., "when you refresh the polls
application" -> "when you visit the admin page")?
While not a great solution as it leaves open the question _why_ it isn't
working with the newly created app, it might still better than to confuse
readers that it _should_ be working.
A much nicer but more extensive change would be to introduce how to create
a base template (and describe extends, like in
https://docs.djangoproject.com/en/4.2/ref/templates/language/#templates)
in tutorial03.
This would be much more invasive as many other parts (e.g., css static
hosting in tutorial06) would need to be adapted, but maybe it's worth the
effort considering how common practice it is to have something like
`base_generic.html`?
What do you think, would one of those changes be acceptable for inclusion?
--
Ticket URL: <https://code.djangoproject.com/ticket/34499#comment:11>