From e86a2cff299b9f3d43b7d14f8ddfd419bf88c51e Mon Sep 17 00:00:00 2001 From: dr-rompecabezas Date: Mon, 17 Feb 2025 20:10:48 -0500 Subject: [PATCH 1/3] Add resources section to the documentation This commit adds a new section to the documentation, "Resources", which provides a curated list of tutorials and talks. Issue #2070 --- docs/changes.rst | 1 + docs/index.rst | 1 + docs/resources.rst | 81 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 83 insertions(+) create mode 100644 docs/resources.rst diff --git a/docs/changes.rst b/docs/changes.rst index 811c60225..9e09fd511 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -6,6 +6,7 @@ Pending * Added Django 5.2 to the tox matrix. * Updated package metadata to include well-known labels. +* Added resources section to the documentation. 5.0.1 (2025-01-13) ------------------ diff --git a/docs/index.rst b/docs/index.rst index e72037045..48c217b1a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,7 @@ Django Debug Toolbar tips panels commands + resources changes contributing architecture diff --git a/docs/resources.rst b/docs/resources.rst new file mode 100644 index 000000000..190b34a47 --- /dev/null +++ b/docs/resources.rst @@ -0,0 +1,81 @@ +Resources +========= + +Tutorials +--------- + +Django Debugging Tutorial +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Originally presented as an in-person workshop at DjangoCon US 2022, this +tutorial by **Tim Schilling** covers debugging techniques in Django. Follow +along independently using the slides and GitHub repository. + +* `Read the blog post `__ +* `Follow along with the GitHub repo `__ +* Last updated: February 13, 2025. +* Estimated time to complete: 1-2 hours. + +Mastering Django Debug Toolbar: Efficient Debugging and Optimization Techniques +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This tutorial by **Bob Berderbos** provides an in-depth look at effectively +using Django Debug Toolbar to debug Django applications, covering installation, +configuration, and practical usage. + +* `Watch on YouTube `__ +* Published: May 13, 2023. +* Duration: 11 minutes. + +Talks +----- + +A Related Matter: Optimizing Your Web App by Using Django Debug Toolbar +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Presented at DjangoCon US 2024 by **Christopher Adams**, this talk delves into +optimizing web applications using Django Debug Toolbar, focusing on SQL query +analysis and performance improvements. + +* `Watch on DjangoTV `__ +* `Watch on YouTube `__ +* Published: December 6, 2024. +* Duration: 26 minutes. + +Fast on My Machine: How to Debug Slow Requests in Production +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Presented at DjangoCon Europe 2024 by **Raphael Michel**, this talk explores +debugging slow requests in production. While not focused on Django Debug +Toolbar, it highlights performance issues the tool can help diagnose. + +* `Watch on DjangoTV `__ +* `Watch on YouTube `__ +* Published: July 11, 2024. +* Duration: 23 minutes. + +Criteria for Inclusion +---------------------- + +The following criteria ensure that included resources are relevant, +informative, and valuable to users: + +1. Relevance to Django Debug Toolbar +2. Originality and expertise +3. Recency and accuracy +4. Production quality +5. Practicality and depth +6. Language and accessibility + +Contributing +------------ + +If you have a video talk or tutorial that you believe should be included in +this list, please consider contributing. + +See the :doc:`contributing documentation ` for details. + +We are looking for resources that provide insights into using Django Debug +Toolbar for use cases beyond the basic setup and configuration. Talks and +tutorials that cover advanced debugging techniques, performance optimization, +and real-world applications are particularly welcome. From 0d935da915fa2b1c80fe0ad8a9cf86c03fcd9659 Mon Sep 17 00:00:00 2001 From: dr-rompecabezas Date: Wed, 19 Feb 2025 12:45:08 -0500 Subject: [PATCH 2/3] Update resources links and contributing notes - Favor conference site links and DjangoTV over YouTube - Make the invitation to contribute more inviting - Remove the criteria for inclusion and contributing sections #2070 --- docs/resources.rst | 44 +++++++++++++++++++------------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/docs/resources.rst b/docs/resources.rst index 190b34a47..1ae3ce38f 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -11,8 +11,9 @@ Originally presented as an in-person workshop at DjangoCon US 2022, this tutorial by **Tim Schilling** covers debugging techniques in Django. Follow along independently using the slides and GitHub repository. -* `Read the blog post `__ -* `Follow along with the GitHub repo `__ +* `View the tutorial details on the conference website `__ +* `Follow along with the GitHub repository `__ +* `View the slides on Google Docs `__ * Last updated: February 13, 2025. * Estimated time to complete: 1-2 hours. @@ -37,8 +38,8 @@ Presented at DjangoCon US 2024 by **Christopher Adams**, this talk delves into optimizing web applications using Django Debug Toolbar, focusing on SQL query analysis and performance improvements. +* `View the talk details on the conference website `__ * `Watch on DjangoTV `__ -* `Watch on YouTube `__ * Published: December 6, 2024. * Duration: 26 minutes. @@ -49,33 +50,26 @@ Presented at DjangoCon Europe 2024 by **Raphael Michel**, this talk explores debugging slow requests in production. While not focused on Django Debug Toolbar, it highlights performance issues the tool can help diagnose. +* `View the talk details on the conference website `__ * `Watch on DjangoTV `__ -* `Watch on YouTube `__ * Published: July 11, 2024. * Duration: 23 minutes. -Criteria for Inclusion ----------------------- +Want to Add Your Content Here? +------------------------------ -The following criteria ensure that included resources are relevant, -informative, and valuable to users: +Have a great tutorial or talk about Django Debug Toolbar? We'd love to +showcase it! If your content helps developers improve their debugging skills, +follow our :doc:contributing guidelines to submit it. -1. Relevance to Django Debug Toolbar -2. Originality and expertise -3. Recency and accuracy -4. Production quality -5. Practicality and depth -6. Language and accessibility +To ensure relevant and accessible content, please check the following +before submitting: -Contributing ------------- +1. Does it at least partially focus on the Django Debug Toolbar? +2. Does the content show a version of Django that is currently supported? +3. What language is the tutorial in and what languages are the captions + available in? -If you have a video talk or tutorial that you believe should be included in -this list, please consider contributing. - -See the :doc:`contributing documentation ` for details. - -We are looking for resources that provide insights into using Django Debug -Toolbar for use cases beyond the basic setup and configuration. Talks and -tutorials that cover advanced debugging techniques, performance optimization, -and real-world applications are particularly welcome. +Talks and tutorials that cover advanced debugging techniques, +performance optimization, and real-world applications are particularly +welcome. From cc262ea746ee0036879c353036f72f588ac4a1ec Mon Sep 17 00:00:00 2001 From: Tim Schilling Date: Tue, 25 Feb 2025 08:19:32 -0600 Subject: [PATCH 3/3] Add a page description and fix the doc link. --- docs/resources.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/resources.rst b/docs/resources.rst index 1ae3ce38f..cbb50a7c3 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -1,6 +1,9 @@ Resources ========= +This section includes resources that can be used to learn more about +the Django Debug Toolbar. + Tutorials --------- @@ -60,7 +63,7 @@ Want to Add Your Content Here? Have a great tutorial or talk about Django Debug Toolbar? We'd love to showcase it! If your content helps developers improve their debugging skills, -follow our :doc:contributing guidelines to submit it. +follow our :doc:`contributing guidelines ` to submit it. To ensure relevant and accessible content, please check the following before submitting: