Skip to content

docs: add django default settings to installation guide - #674

Closed
kawa800 wants to merge 1 commit into
Archmonger:masterfrom
kawa800:docs/fix-installation-guide
Closed

kawa800 wants to merge 1 commit into
Archmonger:masterfrom
kawa800:docs/fix-installation-guide

Conversation

@kawa800

@kawa800 kawa800 commented Aug 16, 2026

Copy link
Copy Markdown

Description

The current documentation for Step 3: Choose a storage backend leaves the default setting for STORAGES blank.

When a first-time user copies and pastes the text into settings.py and runs python manage.py dbbackup it causes a staticfiles.E005 error.

Include the Django >=4.2 default setting instead of the ... to avoid the error and users having to search for the settings themselves.

Checklist

  • Tests have been developed for bug fixes or new functionality.
  • The changelog has been updated, if necessary.
  • Documentation has been updated, if necessary.
  • GitHub Issues closed by this PR have been linked.

By submitting this pull request I agree that all contributions comply with this project's open source license(s).

Previous documentation of configuring settings left the settings blank. This causes a 'staticfiles.E005' error upon running 'python manage.py dbbackup' for the first time'. Including the Django >=4.2 default settings instead of writing '...' is less confusing to readers.
@Archmonger

Copy link
Copy Markdown
Owner

The default app generation in Django emits a STORAGES block, and furthermore the ellipses in our docs is used an indicator that "other user content goes here".

If we insert storage backends, then that would just encourage a different issue where users could copy-and-paste to override their existing backends by mistake. I believe leaving it and allowing an exception to be generated in the failure case is the safest option.

@Archmonger Archmonger closed this Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants