#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:2 by , 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"
?
comment:4 by , 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 , 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 , 11 years ago
Triage Stage: | Unreviewed → Accepted |
---|---|
Type: | Uncategorized → Cleanup/optimization |
comment:7 by , 11 years ago
Mailing-list discussion: https://groups.google.com/forum/#!topic/django-developers/SwzaJMXHGOE
I copied my notes in #21927.
comment:9 by , 10 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Also: