rusackas opened a new pull request, #36805: URL: https://github.com/apache/superset/pull/36805
## Summary This PR introduces an automated database documentation system that generates documentation pages from the `DATABASE_DOCS` dictionary in `superset/db_engine_specs/lib.py`. ### Key Features - **Single source of truth**: All database documentation lives in `lib.py`'s `DATABASE_DOCS` dict - **Auto-generated pages**: Individual MDX pages for each database with connection strings, drivers, auth methods - **Overview table**: Searchable/filterable table showing all databases with scores, features, time grains - **Compatible databases**: PostgreSQL-compatible DBs (YugabyteDB, TimescaleDB, etc.) appear in table - **README sync**: Script can update main README.md database logos via `yarn update:readme-db-logos` - **Promoted navigation**: Databases section moved to top-level nav (not under Configuration) ### Changes - `superset/db_engine_specs/lib.py`: Added `logo`, `homepage_url`, `docs_url` fields to DATABASE_DOCS - `docs/scripts/generate-database-docs.mjs`: New script to generate JSON + MDX from lib.py - `docs/src/components/databases/`: React components for index table and detail pages - `docs/docs/databases/`: Auto-generated MDX pages (53 databases) - `README.md`: Database logos now auto-generated between marker comments ### Usage ```bash # Regenerate docs (runs automatically on build) cd docs && yarn generate:database-docs # Update README logos (manual, opt-in) cd docs && yarn update:readme-db-logos ``` ### Screenshots Database overview table with search, filters, and feature badges. Individual database pages with logos, connection strings, and driver info. ## Test Plan - [x] `yarn build` succeeds in docs/ - [x] Database pages render correctly at /docs/databases/ - [x] Compatible databases appear in overview table - [x] Scores and time grains display correctly - [x] README update is opt-in (doesn't break CI) 🤖 Generated with [Claude Code](https://claude.com/claude-code) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
