This is an automated email from the ASF dual-hosted git repository. rusackas pushed a commit to branch Updated-connection-instructions in repository https://gitbox.apache.org/repos/asf/superset.git
commit 1da6d0c6cd086fad661f0b9c922686dd565d5418 Author: Evan Rusackas <[email protected]> AuthorDate: Tue May 16 12:12:58 2023 -0600 chore(docs): Updating DB connection instructions in 1st Dash instructions --- .../creating-your-first-dashboard.mdx | 25 +++++++++++---------- .../tutorial_01_add_database_connection.png | Bin 0 -> 66937 bytes .../img/tutorial/tutorial_01_sources_database.png | Bin 124949 -> 0 bytes .../img/tutorial/tutorial_02_add_database.png | Bin 44337 -> 0 bytes .../img/tutorial/tutorial_02_select_database.png | Bin 0 -> 218605 bytes .../img/tutorial/tutorial_03_database_name.png | Bin 145591 -> 0 bytes ...utorial_03a_database_connection_string_link.png | Bin 0 -> 236917 bytes .../tutorial_03b_connection_string_details.png | Bin 0 -> 218574 bytes 8 files changed, 13 insertions(+), 12 deletions(-) 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 23a6b777b9..f0b294f29a 100644 --- a/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx +++ b/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx @@ -31,28 +31,29 @@ to query and visualize data from it. If you're using Superset locally via skip this step because a Postgres database, named **examples**, is included and pre-configured in Superset for you. -Under the **Data** menu, select the _Databases_ option: +Under the **+** menu in the top right, select Data, and then the _Connect Database_ option: -<img src={useBaseUrl("/img/tutorial/tutorial_01_sources_database.png" )} />{" "} <br/><br/> +<img src={useBaseUrl("/img/tutorial/tutorial_01_add_database_connection.png" )} />{" "} <br/><br/> -Next, click the green **+ Database** button in the top right corner: +Then select your database type in the resulting modal: -<img src={useBaseUrl("/img/tutorial/tutorial_02_add_database.png" )} />{" "} <br/><br/> +<img src={useBaseUrl("/img/tutorial/tutorial_02_select_database.png" )} />{" "} <br/><br/> -You can configure a number of advanced options in this window, but for this walkthrough you only -need to specify two things (the database name and SQLAlchemy URI): +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: -<img src={useBaseUrl("/img/tutorial/tutorial_03_database_name.png" )} /> +<img src={useBaseUrl("/img/tutorial/tutorial_03a_database_connection_string_link.png" )} />{" "} <br/><br/> -As noted in the text below -the URI, you should refer to the SQLAlchemy documentation on +Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI): + +<img src={useBaseUrl("tutorial_03b_connection_string_details.png" )} /> + +As noted in the text below the form, you should refer to the SQLAlchemy documentation on [creating new connection URIs](https://docs.sqlalchemy.org/en/12/core/engines.html#database-urls) for your target database. Click the **Test Connection** button to confirm things work end to end. If the connection looks good, save the configuration -by clicking the **Add** button in the bottom right corner of the modal window: - -<img src={useBaseUrl("/img/tutorial/tutorial_04_add_button.png" )} /> +by clicking the **Connect** button in the bottom right corner of the modal window: Congratulations, you've just added a new data source in Superset! diff --git a/docs/static/img/tutorial/tutorial_01_add_database_connection.png b/docs/static/img/tutorial/tutorial_01_add_database_connection.png new file mode 100644 index 0000000000..3327ab4b97 Binary files /dev/null and b/docs/static/img/tutorial/tutorial_01_add_database_connection.png differ diff --git a/docs/static/img/tutorial/tutorial_01_sources_database.png b/docs/static/img/tutorial/tutorial_01_sources_database.png deleted file mode 100644 index 33cbfcaa61..0000000000 Binary files a/docs/static/img/tutorial/tutorial_01_sources_database.png and /dev/null differ diff --git a/docs/static/img/tutorial/tutorial_02_add_database.png b/docs/static/img/tutorial/tutorial_02_add_database.png deleted file mode 100644 index 1a1ce19af5..0000000000 Binary files a/docs/static/img/tutorial/tutorial_02_add_database.png and /dev/null differ diff --git a/docs/static/img/tutorial/tutorial_02_select_database.png b/docs/static/img/tutorial/tutorial_02_select_database.png new file mode 100644 index 0000000000..d6bc9f9a55 Binary files /dev/null and b/docs/static/img/tutorial/tutorial_02_select_database.png differ diff --git a/docs/static/img/tutorial/tutorial_03_database_name.png b/docs/static/img/tutorial/tutorial_03_database_name.png deleted file mode 100644 index 40ead2c66e..0000000000 Binary files a/docs/static/img/tutorial/tutorial_03_database_name.png and /dev/null differ diff --git a/docs/static/img/tutorial/tutorial_03a_database_connection_string_link.png b/docs/static/img/tutorial/tutorial_03a_database_connection_string_link.png new file mode 100644 index 0000000000..c4cadc6cd6 Binary files /dev/null and b/docs/static/img/tutorial/tutorial_03a_database_connection_string_link.png differ diff --git a/docs/static/img/tutorial/tutorial_03b_connection_string_details.png b/docs/static/img/tutorial/tutorial_03b_connection_string_details.png new file mode 100644 index 0000000000..8d497cdcc7 Binary files /dev/null and b/docs/static/img/tutorial/tutorial_03b_connection_string_details.png differ
