Skip to content

fix(docs): correct DB module filename for editing + update DB metadata file#37990

Open
hainenber wants to merge 2 commits intomasterfrom
fix/correct-db-module-filename-for-editing
Open

fix(docs): correct DB module filename for editing + update DB metadata file#37990
hainenber wants to merge 2 commits intomasterfrom
fix/correct-db-module-filename-for-editing

Conversation

@hainenber
Copy link
Contributor

@hainenber hainenber commented Feb 16, 2026

fix(docs): correct DB module filename for editing + update DB metadata file

SUMMARY

Fixes below issue in Supported databases pages whereby URL for editing the DB module file is completely amiss.

image image

Due to how DB diagnostics file got generated in python-integrationtest CI, the module value is prefixed with superset.db_engine_specs. When Docs Deployment CI reused said artifacts without further modifications, the bug materializes.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before is already present in the current docs, AWS Athena for example.

After with testing instructions to simulate running Docs Deployment in CI
image

TESTING INSTRUCTIONS

  1. Go to latest python-integrationtest CI step and download the databases-diagnostics build artifacts
  2. Unzip said build artifact and replace the docs/src/data/databases.json with the unzipped JSON
  3. Make sure you have superset installed in your dev env
  4. Go to /docs and run node scripts/generate-database-docs.mjs
  5. Run yarn build and yarn serve to compare.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • 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

Signed-off-by: hainenber <dotronghai96@gmail.com>
Signed-off-by: hainenber <dotronghai96@gmail.com>
@bito-code-review
Copy link
Contributor

bito-code-review bot commented Feb 16, 2026

Code Review Agent Run #ff37f9

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: b987e47..dc53ba1
    • docs/src/components/databases/DatabasePage.tsx
  • Files skipped - 1
    • docs/src/data/databases.json - Reason: Filter setting
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Feb 16, 2026
@codeant-ai-for-open-source
Copy link
Contributor

Sequence Diagram

The PR ensures the documentation page derives the correct engine spec filename from a database's module value (stripping any package prefix) so the "Edit on GitHub" link opens the right .py file. This diagram shows the main success path from a docs user viewing a DB page to following the corrected edit link.

sequenceDiagram
    participant User
    participant DocsSite
    participant GitHub

    User->>DocsSite: Open database documentation page
    DocsSite->>DocsSite: Derive filename = lastSegment(database.module) + ".py"
    DocsSite-->>User: Render "Edit" link pointing to superset/db_engine_specs/<filename>.py
    User->>GitHub: Click "Edit" link (opens correct engine spec file)
Loading

Generated by CodeAnt AI

@netlify
Copy link

netlify bot commented Feb 16, 2026

Deploy Preview for superset-docs-preview ready!

Name Link
🔨 Latest commit dc53ba1
🔍 Latest deploy log https://app.netlify.com/projects/superset-docs-preview/deploys/6992b3f569316600089994cb
😎 Deploy Preview https://deploy-preview-37990--superset-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hainenber hainenber changed the title fix(docs): correct DB module filename for editing fix(docs): correct DB module filename for editing + update DB metadata file Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Namespace | Anything related to documentation size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant