Opened 11 years ago

Closed 10 years ago

Last modified 10 years ago

#20734 closed Cleanup/optimization (fixed)

URL namespacing documentation should be clearer

Reported by: Daniele Procida Owned by: nobody
Component: Documentation Version: 1.5
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 are a couple of places in the documentation that refer to "application instances":

<https://docs.djangoproject.com/en/dev/topics/http/urls/#introduction>
<https://docs.djangoproject.com/en/dev/ref/contrib/admin/#multiple-admin-sites-in-the-same-urlconf>

However, it's not really clear what an application instance is or why I might need to deploy multiple instances of one.

I think that's worth explaining in the documentation, especially since I have found a number of questions and discussions on the subject elsewhere.

I'd suggest that the explanation be incorporated in the URLs documentation.

Change History (10)

comment:1 by Daniele Procida, 11 years ago

Also:

Last edited 11 years ago by Daniele Procida (previous) (diff)

comment:2 by Daniele Procida, 11 years ago

And in https://docs.djangoproject.com/en/dev/intro/tutorial03/#namespacing-url-names, instead of namespace="polls", should we not be advising to use app_name="polls"?

Last edited 11 years ago by Daniele Procida (previous) (diff)

comment:3 by Tim Graham, 11 years ago

Duplicate/related #17707?

comment:4 by Daniele Procida, 11 years ago

Yes, there's some overlap. However, this one's a bit more specific, and also I once I start to get the answers clear in my head I will do some work on a patch to see if I can improve the documentation. How about a link from that one to this one?

comment:5 by Aymeric Augustin, 11 years ago

I have a file with notes from a discussion I had with Malcolm at DjangoCon US last year. I plan (at some point) to clarify the use case of url namespaces, and maybe to relax some constraints on their use. I want to do it because it's part of Malcolm's legacy but it hasn't reached the top of my TODO list for Django yet.

comment:6 by Tim Graham, 11 years ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

comment:7 by Aymeric Augustin, 10 years ago

comment:8 by Tim Graham, 10 years ago

Has patch: set

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

Resolution: fixed
Status: newclosed

In a2bcec34918ba38a22b46aa5b24317c90fecf0b0:

Fixed #17707, #20734 -- Added examples to URL namespacing docs.

Thanks Daniele Procida for review.

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

In 588afbb2be6cf03afde8e1b17980bea09f54ba9a:

[1.7.x] Fixed #17707, #20734 -- Added examples to URL namespacing docs.

Thanks Daniele Procida for review.

Backport of a2bcec3491 from master

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