Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#24961 closed Cleanup/optimization (fixed)

Show links to all auth docs from main index

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

Description

There's a whole set of pages in the auth docs - about using the framework, password management, and customizing - but these are not surfaced on the main docs index page.

I have a branch (https://github.com/danielroseman/django/tree/auth_docs_on_index) which adds links to these in the same bold heading/pipe-separated details format that we use for other subsections like Testing and Deployment, but that would make this the only element under "Common Web application tools" to use that format, which might look odd.

The alternative is to extract Authentication into its own main heading, as we do with Internationalization, Performance, etc.

Change History (5)

comment:1 by Daniel Roseman, 9 years ago

Component: UncategorizedDocumentation

comment:2 by Tim Graham, 9 years ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

I think your tentative patch is okay. You could also add ref/contrib/auth.

comment:3 by Daniel Roseman, 9 years ago

Has patch: set

Thanks @timgraham, updated and PR made: https://github.com/django/django/pull/4840

comment:4 by Tim Graham <timograham@…>, 9 years ago

Resolution: fixed
Status: newclosed

In fd09491:

Fixed #24961 -- Added links to all auth docs pages from index.

comment:5 by Tim Graham <timograham@…>, 9 years ago

In b3f61f6e:

[1.8.x] Fixed #24961 -- Added links to all auth docs pages from index.

Backport of fd0949181f993fb8a15c5b0128840f71ee1d7b0e from master

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