Make documentation links in error messages consistent

[Nikolas N]

This page links to this page:

​http://docs.djangoproject.com/en/dev/ref/contrib/csrf/#ref-contrib-csrf

Which is a 404. Maybe this should be:

​https://docs.djangoproject.com/en/1.7/ref/contrib/csrf/

[Baptiste Mispelon]

Hi,

The offending line can be found here: ​https://github.com/django/django/blob/master/django/views/csrf.py#L69

We should also make this link https instead of just http and I'm also wondering if the link should point to the version of Django being used instead of the dev version (not sure how feasible that is though).

I'm going to bump the severity as well since we should backport that fix.

Thanks.

[Claude Paroz]

from django.utils.version import get_major_version :-)

[Baptiste Mispelon]

Replying to claudep:

from django.utils.version import get_major_version :-)

That would help, yes. But not for the development version though :)

[Claude Paroz]

Ritgh, we'll need something a bit more elaborate, something like if 'alpha' in django.VERSION or 'beta' in django.VERSION: ver = 'stable'; else: ver = get_major_version.

[Bibhas C Debnath]

Looking for feedback. Is this over-engineered? ​https://github.com/iambibhas/django/commit/2050933081bd7b3e28817e1d883c251812b219e7

[Tim Graham]

I think we should change the link in django/master and see if we can simply add a redirect for compatibility with older versions. I don't think generating smarts links based on the version of Django offers much benefit.

[Bibhas C Debnath]

Right now, adding a redirect would solve the broken link issue without any code changes. I came across this when visiting the DRF doc and the url there is broken as well.

[Claude Paroz]

We already have something like that in:
​https://github.com/django/django/blob/master/django/core/management/templates.py#L103

Then I've identified some locations which could benefit from a common implementation of the docs version number:

django/contrib/gis/db/models/__init__.py:        "See also https://docs.djangoproject.com/en/stable/ref/contrib/gis/install/geolibs/")
django/core/management/commands/squashmigrations.py:                    "https://docs.djangoproject.com/en/1.7/topics/migrations/#squashing-migrations"
django/core/management/sql.py:            "see: https://docs.djangoproject.com/en/dev/ref/settings/#databases")
django/db/migrations/state.py:                        "https://docs.djangoproject.com/en/1.7/topics/migrations/#dependencies "
django/db/migrations/writer.py:                    "https://docs.djangoproject.com/en/dev/topics/migrations/#serializing-values"
django/db/migrations/writer.py:                "migration files.\nFor more, see https://docs.djangoproject.com/en/dev/"
django/utils/deconstruct.py:                    "https://docs.djangoproject.com/en/dev/topics/migrations/#serializing-values"
django/views/csrf.py:  href='http://docs.djangoproject.com/en/dev/ref/contrib/csrf/#ref-contrib-csrf'>Django's
django/views/csrf.py:    href='http://docs.djangoproject.com/en/dev/ref/templates/api/#subclassing-context-requestcontext'><code>RequestContext</code></a>

So I think that django.utils.version could have a new get_docs_version utility.

[Bibhas C Debnath]

That sounds good. But how to handle the url change other than the version number e.g. in this case csrf page has moved from contrib/?

[Claude Paroz]

The url change could/should be handled by a compatibility redirect, as mentioned by Tim in comment:6.

[Claude Paroz]

I've just added the redirect for short-term resolution of the issue. Code still needs to be updated.

[Claude Paroz <claude@…>]

In 234a2e0b6bcad5536d5d6cbb398eb6b7cc4eb67e:

Fixed #23866 -- Harmonized refs to Django documentation from code

[Claude Paroz <claude@…>]

In ffa548fb561d4e32b42566cc67a2499a5e321944:

Updated link to CSRF docs

Refs #23866.