jazzband / django-debug-toolbar

A configurable set of panels that display various debug information about the current request/response.
https://django-debug-toolbar.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
8.07k stars 1.05k forks source link

How to use it? #2008

Open GabeSoler opened 2 days ago

GabeSoler commented 2 days ago

Hi, I am new here and followed the installation instructions. However, there are no instructions about how to move from there, where to look for things working, or anything that could guide me to use the app. I imagine this is obvious to everyone, but I will need to look for a tutorial on this app, which I think defeats the purpose of documentation. (I know this is an amazing app and highly recommended, but it is frustrating to not get any guide after 'how to install things', and have pages of configuration when I do not know how to open the bar yet)

tim-schilling commented 2 days ago

Hi @GabeSoler, interestingly enough I was thinking about this this morning. Though more in the context of listing the resources that mention the toolbar.

Here are a few that I found from a quick search. I don't know how reasonable any of them are:

I have a workshop project that I haven't updated since Django 4.0, but it should still work well enough for you to get an understanding of how to do things: https://github.com/tim-schilling/debug-tutorial/

GabeSoler commented 2 days ago

Hi, thanks for the response :) I will check the resources. Your workshop looks really complete and worth looking at in more depth. I read a bit from the Django for professionals that also explained set up and some uses.

Sorry I wrote a bit frustrated, but it's such an important piece in the Django ecosystem that I would love to see it more friendly for beginners.

tim-schilling commented 2 days ago

Sorry I wrote a bit frustrated, but it's such an important piece in the Django ecosystem that I would love to see it more friendly for beginners.

I've been there so many times. At least you recognized that you were frustrated when you wrote it and apologized. I appreciate that :blush:.