[Django] #34146: Add tutorial step for installing third party package(s)
Django
---------------------------------------------+------------------------
Reporter: Timothy Schilling | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version:
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
---------------------------------------------+------------------------
As per discussions with Carlton on Twitter and in person at DjangoCon,
there's benefit in adding a step to the tutorial that covers the
following:
- An overview of the Django Debug Toolbar.
- Where to look for help on packages and/or building application.
- Highlight Django REST framework.
- Highlight djangopackages.com and grids for APIs and development tools.
- Evaluating third party packages via [https://adamj.eu/tech/2021/11/04
/the-well-maintained-test/ Adam Johnson's post]
Let me know if there's something else I should include. I'll have a PR
with a first draft up shortly.
--
Ticket URL: <https://code.djangoproject.com/ticket/34146>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Timothy Schilling | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Mariusz Felisiak):
Thanks for this ticket, however, as far as I'm aware, none of them fit the
tutorial definition according to the Diátaxis framework. They are rather
How-to's and Topics.
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:1>
Django
-----------------------------------+--------------------------------------
Reporter: Timothy Schilling | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------------+--------------------------------------
* has_patch: 0 => 1
Comment:
Link to [https://github.com/django/django/pull/16271 PR].
That's a fair point. The purpose here is to help beginners understand how
to go about adding additional libraries into their project. This tutorial
and the Django Girls tutorial are the two places that most absolute
beginners are linked to. If there's a better way we can structure things,
but still achieve that purpose I'm happy to do the leg work.
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:2>
Django
-----------------------------------+------------------------------------
Type: New feature | Status: new
Component: Documentation | Version:
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------------+------------------------------------
* stage: Unreviewed => Accepted
Comment:
Let's advance it. I think we can ask Danielle if he has capacity on the PR
to assist. (I can try to make the case that it's a tutorial about using
third-party apps, for which selection and assessment is a vital part, and
then we can see what he says 😜)
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:3>
Django
Reporter: Timothy Schilling | Owner: Aravind
| Swaminathan
Type: New feature | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Aravind Swaminathan):
* owner: nobody => Aravind Swaminathan
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:4>
Django
-------------------------------------+-------------------------------------
| Schilling
Type: New feature | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: Aravind Swaminathan => Timothy Schilling
Comment:
Timothy already prepared the patch.
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Type: New feature | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
Comment:
Marking as Patch needs improvement whilst in progress.
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Type: New feature | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Type: New feature | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* version: => 4.2
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Type: New feature | Status: assigned
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* needs_better_patch: 1 => 0
* easy: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Component: Documentation | Version: 4.2
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"7715c9fef55c8775608cdb64d5666c7f90ada937" 7715c9f]:
{{{
#!CommitTicketReference repository=""
revision="7715c9fef55c8775608cdb64d5666c7f90ada937"
Fixed #34146 -- Added 3rd-party lib tutorial step.
Added a tutorial step that highlights Django Debug Toolbar, on of the
most common third party packages. It also added a mention of
djangopackages.com as a place to search for other libraries and a
link to Adam Johnson’s post on evaluating whether a package is
well-maintained.
Third-party packages are one of Django’s strengths. This should give
folks a sound route in.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:10>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Type: New feature | Status: closed
Component: Documentation | Version: 4.2
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"1df7814e4b76211a13eaecd77a05137006b82723" 1df7814e]:
{{{
#!CommitTicketReference repository=""
revision="1df7814e4b76211a13eaecd77a05137006b82723"
Refs #34146 -- Fixed typos in tutorial. (#16530)
- Fixed formatting on index page.
- Removed duplicate What's next section.
Thanks to Tim Graham for the report.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:11>
Django
-------------------------------------+-------------------------------------
Reporter: Timothy Schilling | Owner: Timothy
| Schilling
Type: New feature | Status: closed
Component: Documentation | Version: 4.2
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Carlton Gibson <carlton.gibson@…>):
In [changeset:"757c456d232279ae57546c9c39a9f81183c8a82f" 757c456d]:
{{{
#!CommitTicketReference repository=""
revision="757c456d232279ae57546c9c39a9f81183c8a82f"
[4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step.
Added a tutorial step that highlights Django Debug Toolbar, on of the
most common third party packages. It also added a mention of
djangopackages.com as a place to search for other libraries and a
link to Adam Johnson’s post on evaluating whether a package is
well-maintained.
Third-party packages are one of Django’s strengths. This should give
folks a sound route in.
Backport of 7715c9fef55c8775608cdb64d5666c7f90ada937 and
1df7814e4b76211a13eaecd77a05137006b82723 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34146#comment:12>