9bf60d3d7e
Background: of the four versioned docs sections, three (admin_docs,
developer_docs, components) use the standard Docusaurus
`<plugin_id>_versioned_docs` / `<plugin_id>_versioned_sidebars` /
`<plugin_id>_versions.json` naming on disk. The fourth — the
user-docs section — was wired through preset-classic's bundled docs
slot, which uses the special "default" plugin id that gets no prefix
(`versioned_docs/`, `versioned_sidebars/`, `versions.json`). This is
a Docusaurus quirk, not a Superset choice, but the result is
inconsistent top-level layout and a confusingly-bare `versioned_docs`
that looks like a global rather than a per-section dir.
Fix: configure user-docs as an explicit `plugin-content-docs`
instance with `id: 'user_docs'` instead of relying on
preset-classic's default docs slot. Now all four sections produce
parallel-named files at the docs/ root.
Changes:
- docusaurus.config.ts: add user_docs to dynamicPlugins; set
`docs: false` on preset-classic.
- versions-config.json: rename `docs` key → `user_docs`.
- File renames (preserves git history via `git mv`):
versioned_docs/ → user_docs_versioned_docs/
versioned_sidebars/ → user_docs_versioned_sidebars/
versions.json → user_docs_versions.json
- src/theme/DocVersionBadge/index.js: update PLUGIN_ID_TO_BASE_PATH
(`default` → `user_docs`) and refresh the comment.
- scripts/manage-versions.mjs: drop every `section === 'docs'`
special case; the user_docs section's source dir is still `docs/`
(we didn't rename the content folder), but everything else is
uniform with the other three sections — net code reduction.
- package.json: rename `version:add:docs` → `version:add:user_docs`
and `version:remove:docs` → `version:remove:user_docs` script
aliases. CLI breaking change for anyone scripting against these,
but this is internal docs tooling and the new name matches the
on-disk naming.
- README.md, DOCS_CLAUDE.md: update examples and naming notes.
URL impact: none. The user-docs URL prefix is governed by
`routeBasePath: 'user-docs'` (unchanged), not by the plugin id. The
existing 6.0.0 versioned URL `/user-docs/6.0.0/...` continues to
resolve, verified via local `yarn build`.
What this enables: when the next 6.1.0 cut runs (in a follow-up PR
on top of this), the snapshot will land at
`user_docs_versioned_docs/version-6.1.0/` instead of
`versioned_docs/version-6.1.0/`, and the top-level docs/ directory
will list its versioning artifacts in four parallel sets — much
easier to scan during review.
Superset
A modern, enterprise-ready business intelligence web application.
Documentation
- User Guide — For analysts and business users. Explore data, build charts, create dashboards, and connect databases.
- Administrator Guide — Install, configure, and operate Superset. Covers security, scaling, and database drivers.
- Developer Guide — Contribute to Superset or build on its REST API and extension framework.
Why Superset? | Supported Databases | Release Notes | Get Involved | Resources | Organizations Using Superset
Why Superset?
Superset is a modern data exploration and data visualization platform. Superset can replace or augment proprietary business intelligence tools for many teams. Superset integrates well with a variety of data sources.
Superset provides:
- A no-code interface for building charts quickly
- A powerful, web-based SQL Editor for advanced querying
- A lightweight semantic layer for quickly defining custom dimensions and metrics
- Out of the box support for nearly any SQL database or data engine
- A wide array of beautiful visualizations to showcase your data, ranging from simple bar charts to geospatial visualizations
- Lightweight, configurable caching layer to help ease database load
- Highly extensible security roles and authentication options
- An API for programmatic customization
- A cloud-native architecture designed from the ground up for scale
Screenshots & Gifs
Video Overview
Large Gallery of Visualizations
Craft Beautiful, Dynamic Dashboards
No-Code Chart Builder
Powerful SQL Editor
Supported Databases
Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, and more) that has a Python DB-API driver and a SQLAlchemy dialect.
Here are some of the major database solutions that are supported:
A more comprehensive list of supported databases along with the configuration instructions can be found here.
Want to add support for your datastore or data engine? Read more here about the technical requirements.
Installation and Configuration
Try out Superset's quickstart guide or learn about the options for production deployments.
Get Involved
- Ask and answer questions on StackOverflow using the apache-superset tag
- Join our community's Slack and please read our Slack Community Guidelines
- Join our dev@superset.apache.org Mailing list. To join, simply send an email to dev-subscribe@superset.apache.org
- If you want to help troubleshoot GitHub Issues involving the numerous database drivers that Superset supports, please consider adding your name and the databases you have access to on the Superset Database Familiarity Rolodex
- Join Superset's Town Hall and Operational Model recurring meetings. Meeting info is available on the Superset Community Calendar
Contributor Guide
Interested in contributing? Check out our Developer Guide to find resources around contributing along with a detailed guide on how to set up a development environment.
Resources
- Superset "In the Wild" - see who's using Superset, and add your organization to the list!
- Feature Flags - the status of Superset's Feature Flags.
- Standard Roles - How RBAC permissions map to roles.
- Superset Wiki - Tons of additional community resources: best practices, community content and other information.
- Superset SIPs - The status of Superset's SIPs (Superset Improvement Proposals) for both consensus and implementation status.
Understanding the Superset Points of View
-
Getting Started with Superset
-
Deploying Superset
-
Recordings of Past Superset Community Events
-
Visualizations
Repo Activity
