Fixed #14633 - Organized settings reference docs #620

Closed
wants to merge 3 commits into
from

Projects

None yet

2 participants

@timgraham
Member

Here's a rendered copy of the changes: http://techytim.com/django/14633/ref/settings.html

@estebistec

IANACD (not-a-core-dev), but, I have used a similar organization in my own Django projects in settings.py in the past and so I have some feedback here.

  1. Your breakdown is pretty good but it feels like "core" could use some more breakdown. At the very least I personally like "template" related settings to be broken out. Other candidates include: logging, caches, globalization (i18n/l10n), email, file uploads/media, storages, and security.
  2. I do think that such an organization should be reflected in the settings.py generated by startproject. However, they need not be alphabetized there. So, e.g., perhaps INSTALLED_APPS is one of the first things we would see there. Also, each block mirroring this doc could have a comment block pointing back to relevant doc for both the settings and related core Django app.
@estebistec

Yeah, I like that new topical breakdown!

@timgraham timgraham closed this Jan 12, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment