Opened 12 years ago
Last modified 10 years ago
#18922 closed Bug
Proliferation of dev docs on search engines confuses newbies — at Version 4
Reported by: | Dan Loewenherz | Owned by: | Dan Loewenherz |
---|---|---|---|
Component: | *.djangoproject.com | Version: | 1.4 |
Severity: | Normal | Keywords: | |
Cc: | markus.magnuson@… | Triage Stage: | Accepted |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
I brought this issue up earlier today at DjangoCon, but the basic issue can be summarized hence:
- User searches to find info on a specific feature, gets directed to dev documentation.
- Said feature (on the development version) is backwards incompatible with previous versions of Django.
- User does not know better, assumes Django has a bug.
- Invalid bug is filed in trac.
EDIT: rejected proposal removed, see comment 4.
Change History (4)
comment:1 by , 12 years ago
Owner: | changed from | to
---|
comment:2 by , 12 years ago
Resolution: | → wontfix |
---|---|
Status: | new → closed |
comment:3 by , 12 years ago
This issue wasn't opened with a specific solution in mind--it's just illuminating that this is a problem. I get if the solution I presented is a bit too drastic, but I think closing this ticket ignores the real issue.
comment:4 by , 12 years ago
Description: | modified (diff) |
---|---|
Resolution: | wontfix |
Status: | closed → reopened |
Triage Stage: | Unreviewed → Accepted |
Yes, we can keep this ticket to track other ideas to resolve this problem.
For the record, the original proposal was:
Hopefully, removing the dev documentation pages from search engines will help solve
this issue, since those who want to read the dev docs can just click through to
them by using the version navigation at the bottom of the docs pages.
I think there is a small subset of actual Django users who run their applications
on trunk. I don't have data to back that up but I can't imagine it's a lot.
I talked with Alex earlier today about how to deal with this issue--he also suggested
redirecting users from dev -> 1.4 (or whatever the latest version is). I initially
thought it was a good idea, but I thought about it and realized you would have to at
least add some sort of referrer check. I then thought whether it would be ok to do
something like
def conditional_documentation_redirect(request): if not request.META['REFERER'].startswith("http://docs.djangoproject.com"): return HttpResponseRedirect #... and so on
This felt wrong to me because if that sort of check were in place, users would
no longer be able to permalink to dev docs.
Thanks for the suggestion.
I understand the idea, but I'm not ready to wipe the dev docs from Google's index. People should be able to find information about an upcoming feature by googling its name.
Besides, we take care to mention in which version new feature are added. And closing invalid tickets is cheap. The most troublesome change was the new
{% url %]
, and the flow of tickets eventually stopped.tl;dr The cost of the solution seems too high to me compared to the magnitude of the problem.