mirror of https://github.com/apache/superset.git synced 2026-04-25 11:04:48 +00:00

Files

Evan Rusackas 0fb7fc2721 docs: bifurcate documentation into user, admin, and developer sections

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>

2026-02-24 11:41:27 -08:00

3.0 KiB

Raw Blame History

title, sidebar_position

title	sidebar_position
Storybook	5

Storybook

Superset uses Storybook for developing and testing UI components in isolation. Storybook provides a sandbox to build components independently, outside of the main application.

Public Storybook

A public Storybook with components from the master branch is available at:

apache-superset.github.io/superset-ui

Running Locally

Main Superset Storybook

To run the main Superset Storybook locally:

cd superset-frontend

# Start Storybook (opens at http://localhost:6006)
npm run storybook

# Build static Storybook
npm run build-storybook

@superset-ui Package Storybook

The @superset-ui packages have a separate Storybook for component library development:

cd superset-frontend

# Install dependencies and bootstrap packages
npm ci && npm run bootstrap

# Start the @superset-ui Storybook (opens at http://localhost:9001)
cd packages/superset-ui-demo
npm run storybook

Adding Stories

To an Existing Package

If stories already exist for the package, extend the examples array in the package's story file:

storybook/stories/<package>/index.js

To a New Package

Add package dependencies:
```
npm install <package>
```

Create a story folder matching the package name:

mkdir storybook/stories/superset-ui-<package>/

Create an index.js file with the story configuration:

export default {
  examples: [
    {
      storyPath: '@superset-ui/package',
      storyName: 'My Story',
      renderStory: () => <MyComponent />,
    },
  ],
};

Use the | separator for nested stories:

storyPath: '@superset-ui/package|Category|Subcategory'

Best Practices

Isolate components: Stories should render components in isolation, without application context
Show variations: Create stories for different states, sizes, and configurations
Document props: Use Storybook's controls to expose configurable props
Test edge cases: Include stories for loading states, error states, and empty states

3.0 KiB Raw Blame History