mirror of https://github.com/apache/superset.git synced 2026-04-25 02:55:07 +00:00

Files

Evan Rusackas 43a7138b73 docs: move API reference to developer docs, add active nav state, remove package-lock.json

- Move API reference from user-docs to developer-docs section:
  - Change OpenAPI plugin docsPluginId from 'classic' to 'developer_docs'
  - Move api.mdx and update outputDir to developer_docs/api
  - Update all three API generation scripts to use new paths
  - Update sidebars, navbar items, and redirect targets
  - Add redirect from /user-docs/api to /developer-docs/api
  - Update .gitignore for new generated API path

- Add activeBaseRegex to navbar dropdowns so the active section
  highlights when browsing sub-pages (Users, Admins, Developers,
  Community)

- Fix dropdown active link styling to use primary color instead
  of being invisible (transparent)

- Remove accidental empty package-lock.json from repo root
  (added in SIP-32, 2019)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-25 16:16:05 -08:00

5.2 KiB

Raw Blame History

title, sidebar_position

title	sidebar_position
Overview	1

Apache Superset Developer Portal

Welcome to the Apache Superset Developer Portal - 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