Opened 5 years ago

Closed 3 years ago

Last modified 3 years ago

#13211 closed New feature (fixed)

More Group Documentation in the Auth Page

Reported by: b14ck Owned by: jpaulett
Component: Documentation Version: master
Severity: Normal Keywords: group, authentication, documentation
Cc: rdegges@…, john@…, crazygir@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: yes

Description

The Django auth documentation: http://docs.djangoproject.com/en/dev/topics/auth/ contains very little information about Groups. The documentation does not provide any API reference material for the models.Group objects, and does not go into any detail about how to create, use, or edit groups.

I think that adding in more information about the Group object would be beneficial to coders developing sites that rely heavily on authentication and complex permission schemas.

Attachments (2)

13211.diff (2.0 KB) - added by jpaulett 4 years ago.
Add Group API reference and Permission API example
groups.diff (2.1 KB) - added by CrazyGir 3 years ago.
updated original diff to apply against current trunk

Download all attachments as: .zip

Change History (12)

comment:1 Changed 5 years ago by ubernostrum

  • milestone 1.2 deleted
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Not anywhere near critical enough to go on 1.2.

comment:2 Changed 5 years ago by russellm

  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 4 years ago by gabrielhurley

  • Component changed from Authentication to Documentation

Changed 4 years ago by jpaulett

Add Group API reference and Permission API example

comment:4 Changed 4 years ago by jpaulett

  • Cc john@… added
  • Has patch set
  • Owner changed from nobody to jpaulett

comment:5 Changed 4 years ago by lukeplant

  • Type set to New feature

comment:6 Changed 4 years ago by lukeplant

  • Severity set to Normal

comment:7 Changed 4 years ago by patchhammer

  • Easy pickings unset
  • Patch needs improvement set

13211.diff fails to apply cleanly on to trunk

Changed 3 years ago by CrazyGir

updated original diff to apply against current trunk

comment:8 Changed 3 years ago by CrazyGir

  • Cc crazygir@… added
  • Patch needs improvement unset
  • UI/UX set

First contribution here, please excuse me if I overlook something helpful/important. Thank djangocon for inspiring me to get more involved. I hope this is just the beginning :)

I've taken the previously attached diff and updated it to ensure it applies cleanly to the current trunk revision. I have also made a few updates to the diff to better fit conventions I noticed within the auth docs. I have used built the docs as well, to ensure the changes fit correctly - I believe this is correct but confirmation on this would be great :)

I am removing the "needs improvement" flag, please reflag if you feel more should be tweaked. I believe additional documentation on using Groups might be nice, but I wanted to focus on the first step to get this patch applying cleanly.

comment:9 Changed 3 years ago by jpaulett

  • Triage Stage changed from Accepted to Ready for checkin

comment:10 Changed 3 years ago by julien

  • Resolution set to fixed
  • Status changed from new to closed

In [16849]:

Fixed #13211 -- Added the Group API reference and a Permission API example to the contrib.auth documentation. Thanks to b14ck for the report and to jpaulett and CrazyGir for the patch.

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