This is an automated email from the ASF dual-hosted git repository. maximebeauchemin pushed a commit to branch flask_config in repository https://gitbox.apache.org/repos/asf/superset.git
commit 590d39abeb1999e43e5c7a8f53c6c1dc602b4e38 Author: Maxime Beauchemin <[email protected]> AuthorDate: Fri Jul 18 03:13:18 2025 -0700 feat: enhance config descriptions with markdown formatting - Added markdown formatting to key configuration descriptions - Enhanced SECRET_KEY description with bold emphasis and code formatting - Updated SQLALCHEMY_ENGINE_OPTIONS with link to flask-sqlalchemy documentation - Regenerated config schema and metadata with markdown-formatted content - Configuration table now properly renders: - **Bold text** for important warnings and recommendations - `Code blocks` for configuration examples and commands - [Links](url) that open in new tabs for external documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --- docs/src/resources/config_metadata.json | 8 ++++---- superset/config_defaults.py | 10 +++++----- superset/config_schema.json | 10 +++++----- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/src/resources/config_metadata.json b/docs/src/resources/config_metadata.json index 22e3df2303..1d2d25dc45 100644 --- a/docs/src/resources/config_metadata.json +++ b/docs/src/resources/config_metadata.json @@ -307,7 +307,7 @@ { "key": "SECRET_KEY", "title": "Secret Key", - "description": "Your App secret key. Make sure you override it on superset_config.py or use `SUPERSET_SECRET_KEY` environment variable. Use a strong complex alphanumeric string and use a tool to help you generate a sufficiently random sequence, ex: openssl rand -base64 42\"", + "description": "Your App secret key. **Make sure you override it on superset_config.py** or use `SUPERSET_SECRET_KEY` environment variable. Use a **strong complex alphanumeric string** and use a tool to help you generate a sufficiently random sequence, ex: `openssl rand -base64 42`", "type": "string", "category": "general", "default": "<BoolOp>", @@ -331,7 +331,7 @@ { "key": "SQLALCHEMY_ENGINE_OPTIONS", "title": "Sqlalchemy Engine Options", - "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we recommend READ COMMITTED for regular operation. Find out more here https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/";, + "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we **recommend READ COMMITTED** for regular operation. Find out more here [flask-sqlalchemy config](https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/)", "type": "object", "category": "database", "default": {}, @@ -4152,7 +4152,7 @@ { "key": "SECRET_KEY", "title": "Secret Key", - "description": "Your App secret key. Make sure you override it on superset_config.py or use `SUPERSET_SECRET_KEY` environment variable. Use a strong complex alphanumeric string and use a tool to help you generate a sufficiently random sequence, ex: openssl rand -base64 42\"", + "description": "Your App secret key. **Make sure you override it on superset_config.py** or use `SUPERSET_SECRET_KEY` environment variable. Use a **strong complex alphanumeric string** and use a tool to help you generate a sufficiently random sequence, ex: `openssl rand -base64 42`", "type": "string", "category": "general", "default": "<BoolOp>", @@ -5259,7 +5259,7 @@ { "key": "SQLALCHEMY_ENGINE_OPTIONS", "title": "Sqlalchemy Engine Options", - "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we recommend READ COMMITTED for regular operation. Find out more here https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/";, + "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we **recommend READ COMMITTED** for regular operation. Find out more here [flask-sqlalchemy config](https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/)", "type": "object", "category": "database", "default": {}, diff --git a/superset/config_defaults.py b/superset/config_defaults.py index d77eab5434..d860e0de51 100644 --- a/superset/config_defaults.py +++ b/superset/config_defaults.py @@ -188,10 +188,10 @@ CUSTOM_SECURITY_MANAGER = None SQLALCHEMY_TRACK_MODIFICATIONS = False # --------------------------------------------------------- -# Your App secret key. Make sure you override it on superset_config.py +# Your App secret key. **Make sure you override it on superset_config.py** # or use `SUPERSET_SECRET_KEY` environment variable. -# Use a strong complex alphanumeric string and use a tool to help you generate -# a sufficiently random sequence, ex: openssl rand -base64 42" +# Use a **strong complex alphanumeric string** and use a tool to help you generate +# a sufficiently random sequence, ex: `openssl rand -base64 42` SECRET_KEY = os.environ.get("SUPERSET_SECRET_KEY") or CHANGE_ME_SECRET_KEY # The SQLAlchemy connection string. @@ -207,8 +207,8 @@ SQLALCHEMY_DATABASE_URI = ( # that may be specific to the database engine you are using. # Note that you can use this to set the isolation level of your database, as in # `SQLALCHEMY_ENGINE_OPTIONS = {"isolation_level": "READ COMMITTED"}` -# Also note that we recommend READ COMMITTED for regular operation. -# Find out more here https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/ +# Also note that we **recommend READ COMMITTED** for regular operation. +# Find out more here [flask-sqlalchemy config](https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/) SQLALCHEMY_ENGINE_OPTIONS = {} # In order to hook up a custom password store for all SQLALCHEMY connections diff --git a/superset/config_schema.json b/superset/config_schema.json index b4b5cdeedc..dfe697df51 100644 --- a/superset/config_schema.json +++ b/superset/config_schema.json @@ -1,6 +1,6 @@ { "metadata": { - "generated_from": "/Users/max/code/superset/docs/../superset/config_defaults.py", + "generated_from": "/Users/max/code/superset/superset/config_defaults.py", "total_configs": 218, "description": "Superset configuration schema extracted from config_defaults.py" }, @@ -162,7 +162,7 @@ "SECRET_KEY": { "type": "string", "default": "<BoolOp>", - "description": "Your App secret key. Make sure you override it on superset_config.py or use `SUPERSET_SECRET_KEY` environment variable. Use a strong complex alphanumeric string and use a tool to help you generate a sufficiently random sequence, ex: openssl rand -base64 42\"", + "description": "Your App secret key. **Make sure you override it on superset_config.py** or use `SUPERSET_SECRET_KEY` environment variable. Use a **strong complex alphanumeric string** and use a tool to help you generate a sufficiently random sequence, ex: `openssl rand -base64 42`", "category": "general" }, "SQLALCHEMY_DATABASE_URI": { @@ -174,7 +174,7 @@ "SQLALCHEMY_ENGINE_OPTIONS": { "type": "object", "default": {}, - "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we recommend READ COMMITTED for regular operation. Find out more here https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/";, + "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we **recommend READ COMMITTED** for regular operation. Find out more here [flask-sqlalchemy config](https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/)", "category": "database" }, "SQLALCHEMY_CUSTOM_PASSWORD_STORE": { @@ -1742,7 +1742,7 @@ "SECRET_KEY": { "type": "string", "default": "<BoolOp>", - "description": "Your App secret key. Make sure you override it on superset_config.py or use `SUPERSET_SECRET_KEY` environment variable. Use a strong complex alphanumeric string and use a tool to help you generate a sufficiently random sequence, ex: openssl rand -base64 42\"", + "description": "Your App secret key. **Make sure you override it on superset_config.py** or use `SUPERSET_SECRET_KEY` environment variable. Use a **strong complex alphanumeric string** and use a tool to help you generate a sufficiently random sequence, ex: `openssl rand -base64 42`", "category": "general" }, "WTF_CSRF_EXEMPT_LIST": { @@ -2804,7 +2804,7 @@ "SQLALCHEMY_ENGINE_OPTIONS": { "type": "object", "default": {}, - "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we recommend READ COMMITTED for regular operation. Find out more here https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/";, + "description": "that may be specific to the database engine you are using. Note that you can use this to set the isolation level of your database, as in `SQLALCHEMY_ENGINE_OPTIONS = {\"isolation_level\": \"READ COMMITTED\"}` Also note that we **recommend READ COMMITTED** for regular operation. Find out more here [flask-sqlalchemy config](https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/config/)", "category": "database" }, "SQLALCHEMY_CUSTOM_PASSWORD_STORE": {
