#13211 closed New feature (fixed)
More Group Documentation in the Auth Page
Reported by: | b14ck | Owned by: | John Paulett |
---|---|---|---|
Component: | Documentation | Version: | dev |
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)
Change History (12)
comment:1 by , 15 years ago
milestone: | 1.2 |
---|
comment:2 by , 15 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:3 by , 14 years ago
Component: | Authentication → Documentation |
---|
comment:4 by , 14 years ago
Cc: | added |
---|---|
Has patch: | set |
Owner: | changed from | to
comment:5 by , 14 years ago
Type: | → New feature |
---|
comment:6 by , 14 years ago
Severity: | → Normal |
---|
comment:7 by , 14 years ago
Easy pickings: | unset |
---|---|
Patch needs improvement: | set |
13211.diff fails to apply cleanly on to trunk
by , 13 years ago
Attachment: | groups.diff added |
---|
updated original diff to apply against current trunk
comment:8 by , 13 years ago
Cc: | 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 by , 13 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
Not anywhere near critical enough to go on 1.2.