#37185: Update settings documentation topic with environment variable
-------------------------------+-----------------------------------------
Reporter: Tim Schilling | Type: Uncategorized
Status: new | Component: Documentation
Version: dev | Severity: Normal
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+-----------------------------------------
The settings documentation topic lacks clear direction on how to use the
environment variables to manage settings. We should give a quick example
on how to configure a setting with an environment variable. We should add
a mention to this new section in the
[
https://docs.djangoproject.com/en/6.0/howto/deployment/checklist
/#environment-specific-settings Environment Specific Settings part of the
deployment checklist].
This doesn't need to be overly complex. The SECRET_KEY part of the
deployment checklist already shows 90% of what we should include. Maybe we
show an example of an optional environment variable and potentially
something like `CUSTOM_VAR=value python manage.py <command>` on how to
customize it.
This should also include an admonition to the community maintained
solutions as per
https://github.com/django/new-features/issues/39
--
Ticket URL: <
https://code.djangoproject.com/ticket/37185>
Django <
https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.