Opened 17 months ago

Last modified 5 months ago

#21292 assigned New feature

A how-to or tutorial document for using authentication views and forms is needed

Reported by: EvilDMP Owned by: harisibrahimkv
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: yes
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

There's are some substantial documents in /topics/auth/, but there isn't a step-by-step tutorial or how-to.

There's a need for it in the official documentation, because:

  • it's worthwhile getting users started on the right track, so that they don't find themselves doing it insecurely or incorrectly
  • there are plenty of questions on the subject on StackOverflow and elsewhere
  • there are numerous (often out-of-date or incomplete) weblog articles circulating on the subject

Probably a how-to is more appropriate than a tutorial.

Change History (7)

comment:1 Changed 17 months ago by claudep

  • Component changed from Uncategorized to Documentation
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 12 months ago by timo

#22075 contains some suggestions related to this.

comment:3 Changed 7 months ago by CollinAnderson

We could better document django.contrib.auth.urls

     url('accounts/', include('django.contrib.auth.urls'),

And give an example view that uses UserCreationForm.

Last edited 7 months ago by CollinAnderson (previous) (diff)

comment:4 Changed 6 months ago by collinanderson

  • Owner changed from nobody to collinanderson
  • Status changed from new to assigned

I'm interested in working on this today.

comment:5 Changed 6 months ago by collinanderson

  • Owner collinanderson deleted
  • Status changed from assigned to new

All I got to was an really rough outline:

- login view
- login form
- login template
- login url
- login_required
- logout view
- create view
- create form
- create template
- create url

comment:6 Changed 5 months ago by harisibrahimkv

  • Owner set to harisibrahimkv
  • Status changed from new to assigned

comment:7 Changed 5 months ago by harisibrahimkv

  • Patch needs improvement set

I am working on writing up this tutorial. I have a rough draft ready here: https://github.com/harisibrahimkv/django/blob/3cbcca57465f0dbdf5265b0b80d0bf307ed4505e/docs/topics/auth/tutorial.txt

This is my first time and I am not sure what exactly needs to go in there.

Looking for feedback.

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