mirror of https://github.com/apache/superset.git synced 2026-05-23 08:45:45 +00:00

Files

Claude Code 4ee42fe5b8 docs: cut 6.1.0 versions for user_docs, admin_docs, developer_docs, components

Snapshots all four versioned Docusaurus sections at v6.1.0, cut from
master after the version-cutting tooling (#39837), broken-internal-
links fix (#40102), and user_docs rename (#40171) all landed. With
the rename in place, all four sections now produce parallel-named
files at the docs/ root (no more bare `versioned_docs/` outlier).

Versioning behavior: lastVersion stays at current for every section,
so the canonical URLs (/user-docs/..., /admin-docs/...,
/developer-docs/..., /components/...) continue to render content
from master. The current version is consistently labeled "Next"
with an unreleased banner, and 6.1.0 is a historical pin accessible
only via its explicit version segment.

Component playground: previously disabled: true in versions-config.json,
now enabled and versioned.

Snapshot includes:
- All MDX content for the four sections.
- Auto-gen captured fresh: 74 database pages (engine spec metadata),
  ~1,800 API reference files (openapi.json), 59 component pages
  (Storybook stories).
- Data imports frozen at cut time into snapshot-local _versioned_data/
  dirs:
    user_docs_versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json
      (canonical 80-database diagnostics from master, preserved by the
      generator's input-hash cache)
    admin_docs_versioned_docs/version-6.1.0/_versioned_data/data/countries.json
    admin_docs_versioned_docs/version-6.1.0/_versioned_data/static/feature-flags.json
    developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json
- Import paths in deeply-nested files rewritten so they still resolve
  from one directory deeper inside the snapshot.
- developer_docs/extensions/overview.md snapshot has the FIXED
  ./mcp.md form (from #40102), so the SPA-nav 404 isn't baked into
  the 6.1.0 version.

Verified via full yarn build: exit 0, no broken links surfaced by
onBrokenLinks: throw.

2026-05-15 22:36:30 -07:00

5.2 KiB

Raw Blame History

title, sidebar_position

title	sidebar_position
Overview	1

Developer Docs

Welcome to the Apache Superset Developer Docs - your comprehensive resource for contributing to and extending Apache Superset.

Quick Start

New Contributors

Extension Development

Documentation Sections

Extensions

Learn how to build powerful extensions that enhance Superset's capabilities. This section covers the extension architecture, development patterns, and deployment strategies. You'll find comprehensive guides on creating frontend contributions, managing extension lifecycles, and understanding security implications.

Testing

Comprehensive testing strategies for Superset development. This section covers frontend testing with Jest and React Testing Library, backend testing with pytest, end-to-end testing with Playwright, and CI/CD pipeline best practices.

Contributing to Superset

Everything you need to contribute to the Apache Superset project. This section includes community guidelines, development environment setup, pull request processes, code review workflows, issue reporting guidelines, and Apache release procedures. You'll also find style guidelines for both frontend and backend development.

Development Resources

Prerequisites

Python: 3.9, 3.10, or 3.11
Node.js: 18.x or 20.x
npm: 9.x or 10.x
Git: Basic understanding
React/TypeScript: For frontend development
Flask/SQLAlchemy: For backend development

Key Technologies

Frontend: React, TypeScript, Ant Design, Redux
Backend: Flask, SQLAlchemy, Celery, Redis
Build Tools: Webpack, Babel, npm/yarn
Testing: Jest, Pytest, Playwright
CI/CD: GitHub Actions, pre-commit

Community

Get Help

Slack - Join #development, #troubleshooting, or #beginners
GitHub Discussions - Ask questions and share ideas
Mailing Lists - Development discussions

Contribute

Good First Issues - Start here!
Help Wanted - Issues needing help
Roadmap - See what's planned

Additional Resources

External Documentation

User Documentation - Using Superset
API Documentation - REST API reference
Configuration Guide - Setup and configuration

Important Files

CLAUDE.md - LLM development guide
UPDATING.md - Breaking changes log

Where to Start?

I want to contribute code

I want to build an extension

I found a bug

I need help

Welcome to the Apache Superset community! We're excited to have you contribute.

5.2 KiB Raw Blame History