Opened 89 minutes ago
#37185 new Uncategorized
Update settings documentation topic with environment variable
| Reported by: | Tim Schilling | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
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 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