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>
5.3 KiB
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. 🎉