Opened 18 months ago

Closed 15 months ago

Last modified 15 months ago

#34146 closed New feature (fixed)

Add tutorial step for installing third party package(s)

Reported by: Timothy Schilling Owned by: Timothy Schilling
Component: Documentation Version: 4.2
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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 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.

Change History (12)

comment:1 by Mariusz Felisiak, 18 months ago

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.

comment:2 by Timothy Schilling, 18 months ago

Has patch: set

Link to 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.

comment:3 by Carlton Gibson, 18 months ago

Triage Stage: UnreviewedAccepted

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 😜)

comment:4 by Aravind Swaminathan, 18 months ago

Owner: changed from nobody to Aravind Swaminathan
Status: newassigned

comment:5 by Mariusz Felisiak, 18 months ago

Owner: changed from Aravind Swaminathan to Timothy Schilling

Timothy already prepared the patch.

comment:6 by Carlton Gibson, 18 months ago

Patch needs improvement: set

Marking as Patch needs improvement whilst in progress.

comment:7 by Carlton Gibson, 15 months ago

Triage Stage: AcceptedReady for checkin

comment:8 by Carlton Gibson, 15 months ago

Version: 4.2

comment:9 by Carlton Gibson, 15 months ago

Easy pickings: unset
Patch needs improvement: unset

comment:10 by GitHub <noreply@…>, 15 months ago

Resolution: fixed
Status: assignedclosed

In 7715c9f:

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.

comment:11 by GitHub <noreply@…>, 15 months ago

In 1df7814e:

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.

comment:12 by Carlton Gibson <carlton.gibson@…>, 15 months ago

In 757c456d:

[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

Note: See TracTickets for help on using tickets.
Back to Top