[Django] #24961: Show links to all auth docs from main index

2 views
Skip to first unread message

Django

unread,
Jun 9, 2015, 7:55:58 AM6/9/15
to django-...@googlegroups.com
#24961: Show links to all auth docs from main index
-------------------------------+--------------------
Reporter: danielr | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 1.8
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/24961>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 9, 2015, 7:56:26 AM6/9/15
to django-...@googlegroups.com
#24961: Show links to all auth docs from main index
-------------------------------+--------------------------------------

Reporter: danielr | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by danielr):

* needs_better_patch: => 0
* component: Uncategorized => Documentation
* needs_tests: => 0
* needs_docs: => 0


--
Ticket URL: <https://code.djangoproject.com/ticket/24961#comment:1>

Django

unread,
Jun 9, 2015, 11:18:50 AM6/9/15
to django-...@googlegroups.com
#24961: Show links to all auth docs from main index
--------------------------------------+------------------------------------
Reporter: danielr | Owner: nobody
Type: Cleanup/optimization | Status: new

Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timgraham):

* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted


Comment:

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

--
Ticket URL: <https://code.djangoproject.com/ticket/24961#comment:2>

Django

unread,
Jun 9, 2015, 11:38:02 AM6/9/15
to django-...@googlegroups.com
#24961: Show links to all auth docs from main index
--------------------------------------+------------------------------------
Reporter: danielr | Owner: nobody

Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by danielr):

* has_patch: 0 => 1


Comment:

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

--
Ticket URL: <https://code.djangoproject.com/ticket/24961#comment:3>

Django

unread,
Jun 9, 2015, 12:44:02 PM6/9/15
to django-...@googlegroups.com
#24961: Show links to all auth docs from main index
--------------------------------------+------------------------------------
Reporter: danielr | Owner: nobody
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: new => closed
* resolution: => fixed


Comment:

In [changeset:"fd0949181f993fb8a15c5b0128840f71ee1d7b0e" fd09491]:
{{{
#!CommitTicketReference repository=""
revision="fd0949181f993fb8a15c5b0128840f71ee1d7b0e"
Fixed #24961 -- Added links to all auth docs pages from index.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/24961#comment:4>

Django

unread,
Jun 9, 2015, 12:44:21 PM6/9/15
to django-...@googlegroups.com
#24961: Show links to all auth docs from main index
--------------------------------------+------------------------------------
Reporter: danielr | Owner: nobody

Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"b3f61f6e0840473cfd9485b95752aba572e9a9c9" b3f61f6e]:
{{{
#!CommitTicketReference repository=""
revision="b3f61f6e0840473cfd9485b95752aba572e9a9c9"
[1.8.x] Fixed #24961 -- Added links to all auth docs pages from index.

Backport of fd0949181f993fb8a15c5b0128840f71ee1d7b0e from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/24961#comment:5>

Reply all
Reply to author
Forward
0 new messages