Skip to content

docs: document Databricks OAuth connect flow [sc-17636] - #1448

Merged
emmavdh merged 2 commits into
mainfrom
emma/sc-17636/databricks-oauth-docs
Jul 30, 2026
Merged

docs: document Databricks OAuth connect flow [sc-17636]#1448
emmavdh merged 2 commits into
mainfrom
emma/sc-17636/databricks-oauth-docs

Conversation

@emmavdh

@emmavdh emmavdh commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

What and why?

Documents the Databricks OAuth U2M connect flow shipped in SC-17165 (frontend#2730, backend#3366) for SC-17636.

Before: Docs described PAT-only setup (workspace URL, required warehouse ID, PAT secret, Save Integration).

After:

  • Connection setup documents Authentication Method: OAuth (user login) (recommended) and Personal Access Token
  • OAuth flow: optional client ID/secret, Connect with Databricks, redirect/authorize, tokens never shown
  • PAT path retained for existing/compatible setups
  • SQL Warehouse ID marked optional (required only for table row data via SQL)
  • Reconnect guidance for OAuth token refresh / switching from PAT
  • Quickstart notebook prerequisites and troubleshooting updated to Connections + OAuth
  • configure-connections Databricks field list corrected (was mislabeled Client ID/Secret)

How to test

  1. Mark this PR ready for review (draft PRs skip the preview validate job).
  2. Wait for the validate check to pass and deploy the hosted preview.
  3. Review the updated pages on the PR preview (compare with production as needed):
  4. Confirm the configure dialog screenshot shows OAuth (user login) and Connect with Databricks.
  5. Confirm prerequisites and steps cover OAuth (recommended) and Personal Access Token, optional SQL Warehouse ID, and OAuth reconnect guidance.

Production (current published pages) for side-by-side comparison:

Optional local render:

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/integrations/integrations-examples/synchronize-with-databricks.qmd \
  guide/integrations/configure-connections.qmd \
  notebooks/databricks/validmind_databricks_quickstart.ipynb

What needs special review?

  • Shipped product keeps both OAuth and PAT (not a hard cutover), matching FE/BE PRs.
  • OAuth path hides Initial Status in the UI; docs list it under Personal Access Token only.

Dependencies, breaking changes, and deployment notes

  • Depends on merged implementation: frontend#2730, backend#3366
  • No breaking docs changes; clarifies new recommended auth path

Release notes

Databricks connections can now be set up with OAuth user login in addition to personal access tokens. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied (documentation)
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

Update Databricks connection docs for OAuth user login (with PAT still supported), optional SQL Warehouse ID, and reconnect guidance after SC-17165.

Co-authored-by: Cursor <cursoragent@cursor.com>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Emma Van Der Heide seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

1 similar comment
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Emma Van Der Heide seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@emmavdh emmavdh added the documentation Improvements or additions to documentation label Jul 30, 2026
Replace the PAT-only modal image with the OAuth (user login) configure dialog and move Initial Status to the PAT path only.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh
emmavdh marked this pull request as ready for review July 30, 2026 14:19
@emmavdh emmavdh self-assigned this Jul 30, 2026
@emmavdh
emmavdh requested review from jamadriz and nibalizer July 30, 2026 14:20
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.93 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (2 URL(s))

Show Lighthouse scores

Commit SHA: c1947e4

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/guide/integrations/configure-connections.html 0.94 0.70 1.00 0.82
/guide/integrations/configure-connections.html 0.94 0.67 1.00 0.82
/guide/integrations/integrations-examples/synchronize-with-databricks.html 0.92 0.49 1.00 0.82
/guide/integrations/integrations-examples/synchronize-with-databricks.html 0.92 0.49 1.00 0.82
/guide/integrations/configure-connections.html 0.94 0.69 1.00 0.82
/guide/integrations/integrations-examples/synchronize-with-databricks.html 0.92 0.49 1.00 0.82

@emmavdh
emmavdh added this pull request to the merge queue Jul 30, 2026
Merged via the queue into main with commit 1a8b4b3 Jul 30, 2026
8 of 9 checks passed
@emmavdh
emmavdh deleted the emma/sc-17636/databricks-oauth-docs branch July 30, 2026 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants