Skip to content

Commit a2f0b98

Browse files
authored
feat(docs): uplift Docusaurus to v3 (#28345)
Signed-off-by: hainenber <[email protected]>
1 parent c10cee3 commit a2f0b98

File tree

21 files changed

+2143
-1976
lines changed

21 files changed

+2143
-1976
lines changed

.github/workflows/superset-docs-verify.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ jobs:
2424
with:
2525
persist-credentials: false
2626
submodules: recursive
27-
- name: Set up Node.js 18
27+
- name: Set up Node.js 20
2828
uses: actions/setup-node@v4
2929
with:
30-
node-version: '18'
30+
node-version: '20'
3131
- name: yarn install
3232
run: |
3333
yarn install --check-cache

docs/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v20.12.2

docs/docs/api.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ hide_title: true
44
sidebar_position: 10
55
---
66

7-
import { Buffer } from 'buffer';
8-
global.Buffer = Buffer;
7+
import { Buffer } from 'buffer/index.js';
98
import SwaggerUI from 'swagger-ui-react';
109
import openapi from '/resources/openapi.json';
1110
import 'swagger-ui-react/swagger-ui.css';

docs/docs/configuration/databases.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ in your environment.
1414
You’ll need to install the required packages for the database you want to use as your metadata database
1515
as well as the packages needed to connect to the databases you want to access through Superset.
1616
For information about setting up Superset's metadata database, please refer to
17-
[installation documentation](/docs/installation/)
17+
installation documentations ([Docker Compose](/docs/installation/docker-compose), [Kubernetes](/docs/installation/kubernetes))
1818
:::
1919

2020
This documentation tries to keep pointer to the different drivers for commonly used database
@@ -26,7 +26,7 @@ Superset requires a Python [DB-API database driver](https://peps.python.org/pep-
2626
and a [SQLAlchemy dialect](https://docs.sqlalchemy.org/en/20/dialects/) to be installed for
2727
each database engine you want to connect to.
2828

29-
You can read more [here](/docs/configuration/databases#docker-add-drivers) about how to
29+
You can read more [here](/docs/configuration/databases#installing-drivers-in-docker-images) about how to
3030
install new database drivers into your Superset configuration.
3131

3232
### Supported Databases and Dependencies
@@ -62,7 +62,7 @@ are compatible with Superset.
6262
| [Firebolt](/docs/configuration/databases#firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={name}` |
6363
| [Hologres](/docs/configuration/databases#hologres) | `pip install psycopg2` | `postgresql+psycopg2://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
6464
| [IBM Db2](/docs/configuration/databases#ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` |
65-
| [IBM Netezza Performance Server](/docs/configuration/databases#netezza) | `pip install nzalchemy` | `netezza+nzpy://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
65+
| [IBM Netezza Performance Server](/docs/configuration/databases#ibm-netezza-performance-server) | `pip install nzalchemy` | `netezza+nzpy://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
6666
| [MySQL](/docs/configuration/databases#mysql) | `pip install mysqlclient` | `mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
6767
| [Oracle](/docs/configuration/databases#oracle) | `pip install cx_Oracle` | `oracle://` |
6868
| [PostgreSQL](/docs/configuration/databases#postgres) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
@@ -158,7 +158,7 @@ to your database via the Superset web UI.
158158

159159
As an admin user, go to Settings -> Data: Database Connections and click the +DATABASE button.
160160
From there, follow the steps on the
161-
[Using Database Connection UI page](/docs/configuration/databases#db-connection-ui).
161+
[Using Database Connection UI page](/docs/configuration/databases#connecting-through-the-ui).
162162

163163
Consult the page for your specific database type in the Superset documentation to determine
164164
the connection string and any other parameters you need to input. For instance,
@@ -754,7 +754,7 @@ The recommended connector library for BigQuery is
754754

755755
##### Install BigQuery Driver
756756

757-
Follow the steps [here](/docs/configuration/databases#docker-add-drivers) about how to
757+
Follow the steps [here](/docs/configuration/databases#installing-drivers-in-docker-images) about how to
758758
install new database drivers when setting up Superset locally via docker compose.
759759

760760
```

docs/docs/contributing/contributing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Look through the GitHub issues. Issues tagged with
7979
Superset could always use better documentation,
8080
whether as part of the official Superset docs,
8181
in docstrings, `docs/*.rst` or even on the web as blog posts or
82-
articles. See [Documentation](#documentation) for more details.
82+
articles. See [Documentation](/docs/contributing/howtos#contributing-to-documentation) for more details.
8383

8484
### Add Translations
8585

docs/docs/contributing/guidelines.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Finally, never submit a PR that will put master branch in broken state. If the P
5757
in `requirements.txt` pinned to a specific version which ensures that the application
5858
build is deterministic.
5959
- For TypeScript/JavaScript, include new libraries in `package.json`
60-
- **Tests:** The pull request should include tests, either as doctests, unit tests, or both. Make sure to resolve all errors and test failures. See [Testing](#testing) for how to run tests.
60+
- **Tests:** The pull request should include tests, either as doctests, unit tests, or both. Make sure to resolve all errors and test failures. See [Testing](/docs/contributing/howtos#testing) for how to run tests.
6161
- **Documentation:** If the pull request adds functionality, the docs should be updated as part of the same PR.
6262
- **CI:** Reviewers will not review the code until all CI tests are passed. Sometimes there can be flaky tests. You can close and open PR to re-run CI test. Please report if the issue persists. After the CI fix has been deployed to `master`, please rebase your PR.
6363
- **Code coverage:** Please ensure that code coverage does not decrease.

docs/docs/using-superset/issue-codes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ The database might be under heavy load, running too many queries. Please try aga
267267
One or more parameters specified in the query are malformed.
268268
```
269269

270-
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.
270+
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.
271271

272272
## Issue 1029
273273

0 commit comments

Comments
 (0)