Opened 3 years ago

Closed 3 years ago

#19857 closed Cleanup/optimization (fixed)

Update documentation to include ALLOWED_HOSTS section.

Reported by: anonymous Owned by: nobody
Component: *.djangoproject.com Version: 1.4
Severity: Normal Keywords: ALLOWED_HOSTS, documentation, settings file
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Comment in default settings file has invalid url https://docs.djangoproject.com/en//ref/settings/#allowed-hosts

Searched docs for ALLOWED_HOSTS but found nothing other than Django 1.4.4 release notes.

Change History (8)

comment:1 Changed 3 years ago by carljm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Thanks for the report. The URL it should be linking you to is https://docs.djangoproject.com/en/1.4/ref/settings/#allowed-hosts - the setting is documented in the 1.4 docs, but apparently the search indexing hasn't caught up yet.

The broken link in the new-project template settings is a bug.

comment:2 Changed 3 years ago by Carl Meyer <carl@…>

  • Resolution set to fixed
  • Status changed from new to closed

In 4cdfb24c9847f89a332742dbc476f189de4989dc:

[1.4.x] Fixed #19857 -- Fixed broken docs link in project template.

comment:3 Changed 3 years ago by Carl Meyer <carl@…>

In a6927d821941fa5c25f277479e84e3c32fe005cd:

[1.3.x] Fixed #19857 -- Fixed broken docs link in project template.

Backport of 4cdfb24c98 from 1.4.x.

comment:4 Changed 3 years ago by Carl Meyer <carl@…>

In 8d4342f2c97db93c54a1a5fef26a526caac62df1:

[1.5.x] Fixed #19857 -- Fixed broken docs link in project template.

comment:5 Changed 3 years ago by carljm

Crap. I missed that the {{ docs_version }} project-template substitution was new in trunk, so the link in the project-template settings.py to the documentation for ALLOWED_HOSTS will be broken in all new projects under 1.3.6, 1.4.4, and 1.5c2.

This alone is probably not worth a re-release. Is it possible to add a redirect at dp.com so that https://docs.djangoproject.com/en//ref/settings/#allowed-hosts redirects to https://docs.djangoproject.com/en/1.4/ref/settings/#allowed-hosts ? That'll send 1.3 users to the 1.4 docs, but it's better than a broken link; the ALLOWED_HOSTS documentation is the same for 1.3 and 1.4. (We shouldn't send them to any more recent docs, as those will show an empty list instead of wildcard default value; if we send them to 1.4 then 1.5c2 users will see the wrong default, but better to do that to RC users than production release users, since this'll be fixed correctly for 1.5 final).

comment:6 Changed 3 years ago by carljm

  • Resolution fixed deleted
  • Status changed from closed to new

Reopening, since I don't think this is adequately fixed until we do something to help people who will continue to hit this with 1.3.6 and 1.4.4.

comment:7 Changed 3 years ago by aaugustin

  • Component changed from Documentation to *.djangoproject.com
  • Easy pickings unset
  • Triage Stage changed from Unreviewed to Accepted

I've set up a redirect from /en//ref/settings/ to /en/stable/ref/settings/#allowed-hosts, but for a reason I can't explain, it doesn't work. The same redirect works just fine in dev :(

Edited: removed it since it doesn't work anyway.

Last edited 3 years ago by aaugustin (previous) (diff)

comment:8 Changed 3 years ago by carljm

  • Resolution set to fixed
  • Status changed from new to closed

Closing this; I suspect the problem with the redirect might be that the front-end webserver in production replaces the double slash with a single one, but I don't think it's worth messing with redirects, since we'll have new 1.3 and 1.4 releases today anyway, and a new 1.5 in a week.

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