Aymeric,
I think this is a great start.
I particularly like inserting the links to docs in the form of
docs.djangoproject.com/en/{{ docs_version }}/*
I actually think these sorts of links could be added to admin.py and
views.py as well.
And at least one other could be made more specific (the "see documentation"
note for DATABASES).
This combined with Tim's recent doc improvements will result in some solid
improvements for settings.
-Preston
On Monday, January 28, 2013 1:54:46 PM UTC-8, Aymeric Augustin wrote:
>
> Hello,
>
> I know I'm treading in contentious territory, but -- I figured I'd try
> anyway :)
>
>
> We regularly hear complaints about the default settings file. I've noticed
> the following patterns:
>
> 1) Beginners
> a) Frustration. They skim the comments, tweak the settings and it doesn't
> work as expected. The comments are fairly detailed, but they don't provide
> context like the docs.
> b) Confusion. There's too much information at once. "What am I supposed to
> configure? Is STATICFILES_FINDERS important?"
>
> 2) Experienced users
> a) Boredom. "Why do I have to make the same changes in every new project
> to enable the admin?"
> b) Doubt. "Is using STATICFILES_DIRS the current best practice? It's in
> the default settings file."
>
> Custom templates have improved the situation for advanced users, allowing
> us to focus on making the default project template as simple and
> straightforward as possible.
>
>
> For this purpose, I've created a branch with the following changes:
>
> 1) Add links to the documentation. Remove comments. Documentation goes in
> the docs, not in comments.
> 2) Keep only the most relevant settings in the default settings.py.
> 3) Various improvements along the way.
>
> Compare view:
> https://github.com/aaugustin/django/compare/simplify-project-template
>
> Right now the branch shows that the default settings file can be trimmed
> to 80 lines. I'm reasonably satisfied with the project and app template. I
> still have to synchronize the docs with the changes, especially the
> tutorial.
>
>
> Questions:
> - In general, do you think this is a good idea? Or am I misguided?
> - In detail, are there commits in the branch that seem wrong with regard
> to the current best practices? I don't claim to know them all.
>
>
> Thanks,
>
> --
> Aymeric.
>
> PS: I've purposefully avoided the concept of BASE_DIR because I feel we
> can't reach a consensus on this right now.
>
--
You received this message because you are subscribed to the Google Groups
"Django developers" group.
To post to this group, send email to django-developers@googlegroups.com.
To unsubscribe from this group, send email to
django-developers+unsubscr...@googlegroups.com.
Visit this group at http://groups.google.com/group/django-developers?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
