Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add documentation for DB Connection UI #15599

Merged
merged 5 commits into from Jul 13, 2021
Merged

Conversation

hughhhh
Copy link
Member

@hughhhh hughhhh commented Jul 8, 2021

SUMMARY

Add docs on how users of superset can leverage the new dyanmic form flow for connection databases

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@codecov
Copy link

codecov bot commented Jul 8, 2021

Codecov Report

Merging #15599 (fd3eb8c) into master (4ab565c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #15599   +/-   ##
=======================================
  Coverage   76.88%   76.88%           
=======================================
  Files         976      976           
  Lines       51317    51317           
  Branches     6907     6907           
=======================================
  Hits        39455    39455           
  Misses      11643    11643           
  Partials      219      219           
Flag Coverage Δ
hive 81.29% <ø> (ø)
javascript 71.42% <ø> (ø)
mysql 81.56% <ø> (ø)
postgres 81.58% <ø> (ø)
python 81.96% <ø> (ø)
sqlite 81.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4ab565c...fd3eb8c. Read the comment docs.


There are now 3 steps when creating a new dynamic form:

Step 1: First the admin must inform us what engine they want to connect to. This page is powered by the `/available` endpoint which pulls on the engines currently installed in your environment, so that only supported databases are shown.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nit.. maybe clarify "us"?


**Add Giph for before and after**

There are now 3 steps when creating a new dynamic form:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another nit.. I'd recommend: There are now 3 steps when connecting to a database in the new UI.

@hughhhh hughhhh merged commit 9f969d0 into master Jul 13, 2021
cccs-RyanS pushed a commit to CybercentreCanada/superset that referenced this pull request Dec 17, 2021
* Create ui.mdx

* more fixxxes

* address comments

* Update ui.mdx

* Update ui.mdx
QAlexBall pushed a commit to QAlexBall/superset that referenced this pull request Dec 29, 2021
* Create ui.mdx

* more fixxxes

* address comments

* Update ui.mdx

* Update ui.mdx
cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024
* Create ui.mdx

* more fixxxes

* address comments

* Update ui.mdx

* Update ui.mdx
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.3.0 labels Mar 12, 2024
@mistercrunch mistercrunch deleted the hughhhh/db-connection-ui branch March 26, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 1.3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants