From 1d823a0be50b58e40b8c32123ecf3b1a50b1d244 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 27 Feb 2025 07:57:36 +0100 Subject: [PATCH] chore(docs): fix typos (#32393) --- docs/docs/configuration/alerts-reports.mdx | 2 +- docs/docs/configuration/cache.mdx | 2 +- docs/docs/configuration/configuring-superset.mdx | 6 +++--- docs/docs/configuration/networking-settings.mdx | 2 +- docs/docs/configuration/sql-templating.mdx | 2 +- docs/docs/faq.mdx | 2 +- superset/migrations/shared/utils.py | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs/configuration/alerts-reports.mdx b/docs/docs/configuration/alerts-reports.mdx index 361d6cfbea6..a75de340419 100644 --- a/docs/docs/configuration/alerts-reports.mdx +++ b/docs/docs/configuration/alerts-reports.mdx @@ -143,7 +143,7 @@ SLACK_API_TOKEN = "xoxb-" SMTP_HOST = "smtp.sendgrid.net" # change to your host SMTP_PORT = 2525 # your port, e.g. 587 SMTP_STARTTLS = True -SMTP_SSL_SERVER_AUTH = True # If your using an SMTP server with a valid certificate +SMTP_SSL_SERVER_AUTH = True # If you're using an SMTP server with a valid certificate SMTP_SSL = False SMTP_USER = "your_user" # use the empty string "" if using an unauthenticated SMTP server SMTP_PASSWORD = "your_password" # use the empty string "" if using an unauthenticated SMTP server diff --git a/docs/docs/configuration/cache.mdx b/docs/docs/configuration/cache.mdx index c0eadca95bf..140441c83ee 100644 --- a/docs/docs/configuration/cache.mdx +++ b/docs/docs/configuration/cache.mdx @@ -81,7 +81,7 @@ See [Async Queries via Celery](/docs/configuration/async-queries-celery) for det ## Caching Thumbnails -This is an optional feature that can be turned on by activating it’s [feature flag](/docs/configuration/configuring-superset#feature-flags) on config: +This is an optional feature that can be turned on by activating its [feature flag](/docs/configuration/configuring-superset#feature-flags) on config: ``` FEATURE_FLAGS = { diff --git a/docs/docs/configuration/configuring-superset.mdx b/docs/docs/configuration/configuring-superset.mdx index 4f76f258e62..a6f28f3c410 100644 --- a/docs/docs/configuration/configuring-superset.mdx +++ b/docs/docs/configuration/configuring-superset.mdx @@ -283,7 +283,7 @@ class CustomSsoSecurityManager(SupersetSecurityManager): ... ``` -This file must be located at the same directory than `superset_config.py` with the name +This file must be located in the same directory as `superset_config.py` with the name `custom_sso_security_manager.py`. Finally, add the following 2 lines to `superset_config.py`: ``` @@ -316,7 +316,7 @@ CUSTOM_SECURITY_MANAGER = CustomSsoSecurityManager ### Keycloak-Specific Configuration using Flask-OIDC If you are using Keycloak as OpenID Connect 1.0 Provider, the above configuration based on [`Authlib`](https://authlib.org/) might not work. In this case using [`Flask-OIDC`](https://pypi.org/project/flask-oidc/) is a viable option. -Make sure the pip package [`Flask-OIDC`](https://pypi.org/project/flask-oidc/) is installed on the webserver. This was succesfully tested using version 2.2.0. This package requires [`Flask-OpenID`](https://pypi.org/project/Flask-OpenID/) as a dependency. +Make sure the pip package [`Flask-OIDC`](https://pypi.org/project/flask-oidc/) is installed on the webserver. This was successfully tested using version 2.2.0. This package requires [`Flask-OpenID`](https://pypi.org/project/Flask-OpenID/) as a dependency. The following code defines a new security manager. Add it to a new file named `keycloak_security_manager.py`, placed in the same directory as your `superset_config.py` file. ```python @@ -475,7 +475,7 @@ def FLASK_APP_MUTATOR(app: Flask) -> None: To support a diverse set of users, Superset has some features that are not enabled by default. For example, some users have stronger security restrictions, while some others may not. So Superset -allow users to enable or disable some features by config. For feature owners, you can add optional +allows users to enable or disable some features by config. For feature owners, you can add optional functionalities in Superset, but will be only affected by a subset of users. You can enable or disable features with flag from `superset_config.py`: diff --git a/docs/docs/configuration/networking-settings.mdx b/docs/docs/configuration/networking-settings.mdx index aa760553b82..9936e98a1cd 100644 --- a/docs/docs/configuration/networking-settings.mdx +++ b/docs/docs/configuration/networking-settings.mdx @@ -85,7 +85,7 @@ SUPERSET_FEATURE_EMBEDDED_SUPERSET=true ## CSRF settings -Similarly, [flask-wtf](https://flask-wtf.readthedocs.io/en/0.15.x/config/) is used manage +Similarly, [flask-wtf](https://flask-wtf.readthedocs.io/en/0.15.x/config/) is used to manage some CSRF configurations. If you need to exempt endpoints from CSRF (e.g. if you are running a custom auth postback endpoint), you can add the endpoints to `WTF_CSRF_EXEMPT_LIST`: diff --git a/docs/docs/configuration/sql-templating.mdx b/docs/docs/configuration/sql-templating.mdx index 39bea00d85b..14b910b7141 100644 --- a/docs/docs/configuration/sql-templating.mdx +++ b/docs/docs/configuration/sql-templating.mdx @@ -273,7 +273,7 @@ You can retrieve the value for a specific filter as a list using `{{ filter_valu This is useful if: - You want to use a filter component to filter a query where the name of filter component column doesn't match the one in the select statement -- You want to have the ability for filter inside the main query for performance purposes +- You want to have the ability to filter inside the main query for performance purposes Here's a concrete example: diff --git a/docs/docs/faq.mdx b/docs/docs/faq.mdx index 7ae4ac41323..95599e92a27 100644 --- a/docs/docs/faq.mdx +++ b/docs/docs/faq.mdx @@ -213,7 +213,7 @@ SQLAlchemy and DBAPI scope. This includes features like: Beyond the SQLAlchemy connector, it’s also possible, though much more involved, to extend Superset and write your own connector. The only example of this at the moment is the Druid connector, which is getting superseded by Druid’s growing SQL support and the recent availability of a DBAPI and -SQLAlchemy driver. If the database you are considering integrating has any kind of of SQL support, +SQLAlchemy driver. If the database you are considering integrating has any kind of SQL support, it’s probably preferable to go the SQLAlchemy route. Note that for a native connector to be possible the database needs to have support for running OLAP-type queries and should be able to do things that are typical in basic SQL: diff --git a/superset/migrations/shared/utils.py b/superset/migrations/shared/utils.py index b0a460f588e..2b8eac62ac8 100644 --- a/superset/migrations/shared/utils.py +++ b/superset/migrations/shared/utils.py @@ -287,7 +287,7 @@ def batch_operation( logger.info(f"Progress: {count:,}/{count:,} (100%)") logger.info( - f"End: {GREEN}{callable.__name__}{RESET} batch operation {GREEN}succesfully{RESET} executed." # noqa: E501 + f"End: {GREEN}{callable.__name__}{RESET} batch operation {GREEN}successfully{RESET} executed." # noqa: E501 ) @@ -295,7 +295,7 @@ def add_columns(table_name: str, *columns: Column) -> None: """ Adds new columns to an existing database table. - If a column already exists, it logs an informational message and skips the adding process. + If a column already exist, it logs an informational message and skips the adding process. Otherwise, it proceeds to add the new column to the table. The operation is performed using Alembic's batch_alter_table.