From 041197b6df52c24319cfce32c3052da25b824bc4 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Fri, 29 Sep 2023 09:51:14 -0400 Subject: [PATCH] chore(docs): Spelling (#25453) Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- docs/docs/api.mdx | 2 +- docs/docs/contributing/translations.mdx | 2 +- .../docs/contributing/types-of-contributions.mdx | 4 ++-- .../creating-your-first-dashboard.mdx | 2 +- docs/docs/databases/snowflake.mdx | 2 +- docs/docs/databases/sql-server.mdx | 2 +- .../installing-superset-using-docker-compose.mdx | 2 +- docs/docs/installation/setup-ssh-tunneling.mdx | 2 +- docs/docs/miscellaneous/chart-params.mdx | 16 ++++++++-------- docs/docs/miscellaneous/issue-codes.mdx | 2 +- 10 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/docs/api.mdx b/docs/docs/api.mdx index 762b0c180..fb3572eb3 100644 --- a/docs/docs/api.mdx +++ b/docs/docs/api.mdx @@ -15,7 +15,7 @@ import { Alert } from 'antd'; Superset's public **REST API** follows the [OpenAPI specification](https://swagger.io/specification/), and is -documented here. The docs bellow are generated using +documented here. The docs below are generated using [Swagger React UI](https://www.npmjs.com/package/swagger-ui-react). /LC_MESSAGES/messages.po`, or even create a dictionary for a new language altogether. diff --git a/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx b/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx index f8a1c8d85..a02c9a4ec 100644 --- a/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx +++ b/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx @@ -40,7 +40,7 @@ Then select your database type in the resulting modal: {" "}

Once you've selected a database, you can configure a number of advanced options in this window, -or for the purposes of this this walkthrough, you can click the link below all these fields: +or for the purposes of this walkthrough, you can click the link below all these fields: {" "}

diff --git a/docs/docs/databases/snowflake.mdx b/docs/docs/databases/snowflake.mdx index dd5deb1aa..b4ce74af7 100644 --- a/docs/docs/databases/snowflake.mdx +++ b/docs/docs/databases/snowflake.mdx @@ -40,7 +40,7 @@ button in the Create or Edit Database dialog, user/role credentials are validate is not authorized to access the database, an error is recorded in the Superset logs. And if you want connect Snowflake with [Key Pair Authentication](https://docs.snowflake.com/en/user-guide/key-pair-auth.html#step-6-configure-the-snowflake-client-to-use-key-pair-authentication). -Plase make sure you have the key pair and the public key is registered in Snowflake. +Please make sure you have the key pair and the public key is registered in Snowflake. To connect Snowflake with Key Pair Authentication, you need to add the following parameters to "SECURE EXTRA" field. ***Please note that you need to merge multi-line private key content to one line and insert `\n` between each line*** diff --git a/docs/docs/databases/sql-server.mdx b/docs/docs/databases/sql-server.mdx index 8b7c833c8..ca7a91569 100644 --- a/docs/docs/databases/sql-server.mdx +++ b/docs/docs/databases/sql-server.mdx @@ -19,5 +19,5 @@ It is also possible to connect using [pyodbc](https://pypi.org/project/pyodbc) w The connection string for SQL Server looks like this: ``` -mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3Cmy_server%3E%2C1433%3BDatabase%3Dmy_datasbase%3BUid%3Dmy_user_name%3BPwd%3Dmy_password%3BEncrypt%3Dyes%3BConnection+Timeout%3D30 +mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3Cmy_server%3E%2C1433%3BDatabase%3Dmy_database%3BUid%3Dmy_user_name%3BPwd%3Dmy_password%3BEncrypt%3Dyes%3BConnection+Timeout%3D30 ``` diff --git a/docs/docs/installation/installing-superset-using-docker-compose.mdx b/docs/docs/installation/installing-superset-using-docker-compose.mdx index 46c50d252..e7c1cde63 100644 --- a/docs/docs/installation/installing-superset-using-docker-compose.mdx +++ b/docs/docs/installation/installing-superset-using-docker-compose.mdx @@ -103,7 +103,7 @@ The following is for users who want to configure how Superset runs in Docker Com You can install additional python packages and apply config overrides by following the steps mentioned in [docker/README.md](https://github.com/apache/superset/tree/master/docker#configuration) -You can configure the Docker Compose environment varirables for dev and non-dev mode with `docker/.env` and `docker/.env-non-dev` respectively. These environment files set the environment for most containers in the Docker Compose setup, and some variables affect multiple containers and others only single ones. +You can configure the Docker Compose environment variables for dev and non-dev mode with `docker/.env` and `docker/.env-non-dev` respectively. These environment files set the environment for most containers in the Docker Compose setup, and some variables affect multiple containers and others only single ones. One important variable is `SUPERSET_LOAD_EXAMPLES` which determines whether the `superset_init` container will populate example data and visualizations into the metadata database. These examples are helpful for learning and testing out Superset but unnecessary for experienced users and production deployments. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device. diff --git a/docs/docs/installation/setup-ssh-tunneling.mdx b/docs/docs/installation/setup-ssh-tunneling.mdx index b245a7753..859feaab0 100644 --- a/docs/docs/installation/setup-ssh-tunneling.mdx +++ b/docs/docs/installation/setup-ssh-tunneling.mdx @@ -15,7 +15,7 @@ version: 1 2. Create database w/ ssh tunnel enabled - With the feature flag enabled you should now see ssh tunnel toggle. - Click the toggle to enables ssh tunneling and add your credentials accordingly. - - Superset allows for 2 different type authenticaion (Basic + Private Key). These credentials should come from your service provider. + - Superset allows for 2 different type authentication (Basic + Private Key). These credentials should come from your service provider. 3. Verify data is flowing - Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing. diff --git a/docs/docs/miscellaneous/chart-params.mdx b/docs/docs/miscellaneous/chart-params.mdx index 1cdf726e3..042e79ccb 100644 --- a/docs/docs/miscellaneous/chart-params.mdx +++ b/docs/docs/miscellaneous/chart-params.mdx @@ -15,14 +15,14 @@ Note not all fields are correctly categorized. The fields vary based on visualiz ### Datasource & Chart Type -| Field | Type | Notes | -| ----------------- | -------- | ----------------------------------- | -| `database_name` | _string_ | _Deprecated?_ | -| `datasource` | _string_ | `__` | -| `datasource_id` | _string_ | _Deprecated?_ See `datasource` | -| `datasource_name` | _string_ | _Deprecated?_ | -| `datasource_type` | _string_ | _Deprecated?_ See `datasource` | -| `viz_type` | _string_ | The **Visualization Type** widget | +| Field | Type | Notes | +| ----------------- | -------- | ------------------------------------ | +| `database_name` | _string_ | _Deprecated?_ | +| `datasource` | _string_ | `__` | +| `datasource_id` | _string_ | _Deprecated?_ See `datasource` | +| `datasource_name` | _string_ | _Deprecated?_ | +| `datasource_type` | _string_ | _Deprecated?_ See `datasource` | +| `viz_type` | _string_ | The **Visualization Type** widget | ### Time diff --git a/docs/docs/miscellaneous/issue-codes.mdx b/docs/docs/miscellaneous/issue-codes.mdx index c8e80917f..688b6d893 100644 --- a/docs/docs/miscellaneous/issue-codes.mdx +++ b/docs/docs/miscellaneous/issue-codes.mdx @@ -264,7 +264,7 @@ The database might be under heavy load, running too many queries. Please try aga ## Issue 1028 ``` -One or more parameters specified in the query are malformatted. +One or more parameters specified in the query are malformed. ``` The query contains one or more malformed template parameters. Please check your query and confirm that all template parameters are surround by double braces, for example, "{{ ds }}". Then, try running your query again.