mirror of
https://github.com/apache/superset.git
synced 2026-04-25 11:04:48 +00:00
0fb7fc2721
Major restructuring of documentation to separate concerns: **New Structure:** - `/docs/` - User-facing docs (intro, quickstart, databases, using-superset, faq) - `/admin-docs/` - Administrator docs (installation, configuration, security) - `/developer-docs/` - Developer docs (contributing, extensions, guidelines, testing) **Changes:** - Move installation, configuration, and security docs to admin_docs/ - Move contributing, extensions, guidelines, and testing to developer_docs/ - Rename developer_portal to developer_docs (with underscore to hyphen in URL) - Add sidebarAdminDocs.js for admin documentation navigation - Update versions-config.json with new doc sections - Update docusaurus.config.ts with new plugins and redirects - Update internal links in versioned docs (6.0.0) to use new paths - Keep user-facing content (databases, using-superset, faq) in main docs This separation makes it clearer which documentation is relevant for: - End users exploring and visualizing data - Administrators deploying and configuring Superset - Developers contributing to or extending Superset Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.1 KiB
2.1 KiB
title, sidebar_position
| title | sidebar_position |
|---|---|
| Deployment | 7 |
Deployment
Once an extension has been developed, the deployment process involves packaging and uploading it to the host application.
Packaging is handled by the superset-extensions bundle command, which:
- Builds frontend assets using Webpack (with Module Federation configuration).
- Collects backend Python source files and all necessary resources.
- Generates a
manifest.jsonwith build-time metadata, including the contents ofextension.jsonand references to built assets. - Packages everything into a
.supxfile (a zip archive with a specific structure required by Superset).
To deploy an extension, place the .supx file in the extensions directory configured via EXTENSIONS_PATH in your superset_config.py:
EXTENSIONS_PATH = "/path/to/extensions"
During application startup, Superset automatically discovers and loads all .supx files from this directory:
- Scans the configured directory for
.supxfiles. - Validates each file is a properly formatted zip archive.
- Extracts and validates the extension manifest and metadata.
- Loads the extension, making it available for use.
This file-based approach simplifies deployment in containerized environments and enables version control of extensions alongside infrastructure configuration.