Skip to content

Commit

Permalink
chore(docs): Spelling (apache#25453)
Browse files Browse the repository at this point in the history
Signed-off-by: Josh Soref <[email protected]>
  • Loading branch information
jsoref authored Sep 29, 2023
1 parent b9b557a commit 041197b
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/docs/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<Alert
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing/translations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ for your target language already exists in the `superset/translations` directory
ls superset/translations | grep -E "^[a-z]{2}\/"
```

If your language already has a pre-existing translation, skip to the next section
If your language already has a preexisting translation, skip to the next section

The following languages are already supported by Flask AppBuilder, and will make it
easier to translate the application to your target language:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/contributing/types-of-contributions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The best way to report a bug is to file an issue on GitHub. Please include:
When posting Python stack traces, please quote them using
[Markdown blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/).

_Please note that feature requests opened as Github Issues will be moved to Discussions._
_Please note that feature requests opened as GitHub Issues will be moved to Discussions._

### Submit Ideas or Feature Requests

Expand Down Expand Up @@ -51,7 +51,7 @@ articles. See [Documentation](#documentation) for more details.
### Add Translations

If you are proficient in a non-English language, you can help translate
text strings from Superset's UI. You can jump in to the existing
text strings from Superset's UI. You can jump into the existing
language dictionaries at
`superset/translations/<language_code>/LC_MESSAGES/messages.po`, or
even create a dictionary for a new language altogether.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Then select your database type in the resulting modal:
<img src={useBaseUrl("/img/tutorial/tutorial_02_select_database.png" )} width="600" />{" "} <br/><br/>

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:

<img src={useBaseUrl("/img/tutorial/tutorial_03a_database_connection_string_link.png" )} width="600" />{" "} <br/><br/>

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/databases/snowflake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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***
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/databases/sql-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/installation/setup-ssh-tunneling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
16 changes: 8 additions & 8 deletions docs/docs/miscellaneous/chart-params.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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_ | `<datasouce_id>__<datasource_type>` |
| `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>__<datasource_type>` |
| `datasource_id` | _string_ | _Deprecated?_ See `datasource` |
| `datasource_name` | _string_ | _Deprecated?_ |
| `datasource_type` | _string_ | _Deprecated?_ See `datasource` |
| `viz_type` | _string_ | The **Visualization Type** widget |

### Time

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/miscellaneous/issue-codes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 041197b

Please sign in to comment.