馃摑(doc) sync env.md with actual settings - #799
Open
kernicPanel wants to merge 1 commit into
Open
Conversation
The environment variables documentation had drifted from settings.py: many variables were missing (OIDC resource server, SDK, entitlements, malware detection, metrics, theme...), three documented ones no longer exist, and settings declared without an explicit environ_name were listed without their actual DJANGO_ prefix. Also split the document into general and development/test sections.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
docs/env.md had drifted from the actual settings: many configurable
variables were undocumented, a few documented ones no longer exist, and
some were listed under the wrong name.
Proposal
entitlements, malware detection, metrics, theme customization,
caches...)
FEATURES_ALPHA,ITEM_FILE_MAX_SIZE,SEARCH_INDEXER_MIMETYPES)DJANGO_prefix the settings declaredwithout an explicit
environ_name(CORS_*,EMAIL_*,LANGUAGE_CODE)