Opened 10 years ago

Last modified 22 hours ago

#21292 new New feature

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

Reported by: Daniele Procida Owned by:
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Ülgen Sarıkavak Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
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 (11)

comment:1 by Claude Paroz, 10 years ago

Component: UncategorizedDocumentation
Triage Stage: UnreviewedAccepted

comment:2 by Tim Graham, 10 years ago

#22075 contains some suggestions related to this.

comment:3 by Collin Anderson, 10 years ago

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 10 years ago by Collin Anderson (previous) (diff)

comment:4 by Collin Anderson, 10 years ago

Owner: changed from nobody to Collin Anderson
Status: newassigned

I'm interested in working on this today.

comment:5 by Collin Anderson, 10 years ago

Owner: Collin Anderson removed
Status: assignednew

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 by Haris Ibrahim K. V., 9 years ago

Owner: set to Haris Ibrahim K. V.
Status: newassigned

comment:7 by Haris Ibrahim K. V., 9 years ago

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.

comment:8 by Haris Ibrahim K. V., 8 years ago

Owner: Haris Ibrahim K. V. removed
Status: assignednew

in reply to:  7 comment:9 by Carlos Leite, 8 years ago

Replying to harisibrahimkv:

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.

this link to the article is broken

comment:11 by Jacob Walls, 3 years ago

Needs documentation: unset
Patch needs improvement: unset

Clearing flags for any new attempt when ready.

comment:12 by Ülgen Sarıkavak, 22 hours ago

Cc: Ülgen Sarıkavak added
Note: See TracTickets for help on using tickets.
Back to Top