mirror of https://github.com/apache/superset.git synced 2026-05-08 01:15:46 +00:00

Files

Superset Dev 752ebd47cb docs: cut 6.1.0 versions for docs, admin_docs, developer_docs, components

- Snapshot all four versioned docs sections at v6.1.0; master continues to
  serve as "Next" (lastVersion: current, banner: unreleased) so editing
  master keeps updating the canonical URLs
- Enable the previously-disabled components plugin and version it
- Rename stale "developer_portal" references to "developer_docs" across
  package.json scripts, manage-versions.mjs, theme files (DocVersionBadge,
  DocVersionBanner), DOCS_CLAUDE.md, and README.md (URL backward-compat
  redirect /developer_portal/* preserved)
- Add admin_docs version scripts; drop dead "tutorials" plugin id from
  the version badge
- Generalize fixVersionedImports in manage-versions.mjs to walk every
  section's snapshot and rewrite ../../src/ and ../../data/ imports,
  catching admin_docs and components files that previous version cuts
  would have broken
- Remove orphan files: developer_portal_versions.json,
  tutorials_versions.json, and stray empty versions.json files inside
  components/ and developer_docs/ content directories

2026-05-02 11:53:56 -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