fix(docs): correct DB module filename for editing + update DB metadata file#37990
fix(docs): correct DB module filename for editing + update DB metadata file#37990
Conversation
Signed-off-by: hainenber <dotronghai96@gmail.com>
Signed-off-by: hainenber <dotronghai96@gmail.com>
Code Review Agent Run #ff37f9Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help |
Sequence DiagramThe 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)
Generated by CodeAnt AI |
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
fix(docs): correct DB module filename for editing + update DB metadata file
SUMMARY
Fixes below issue in
Supported databasespages whereby URL for editing the DB module file is completely amiss.Due to how DB diagnostics file got generated in
python-integrationtestCI, themodulevalue is prefixed withsuperset.db_engine_specs. WhenDocs DeploymentCI reused said artifacts without further modifications, the bug materializes.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before is already present in the current docs,
AWS Athenafor example.After with testing instructions to simulate running

Docs Deploymentin CITESTING INSTRUCTIONS
python-integrationtestCI step and download the databases-diagnostics build artifactsdocs/src/data/databases.jsonwith the unzipped JSONsupersetinstalled in your dev env/docsand runnode scripts/generate-database-docs.mjsyarn buildandyarn serveto compare.ADDITIONAL INFORMATION