QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-24 18:44:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8c28c6b474ca3a3e2c19672b6a356956c5c3452e
superset2/docs/developer_docs/index.md
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

136 lines
5.3 KiB
Markdown
Raw Blame History

---
title: Overview
sidebar_position: 1
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# 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
- [Contributing Overview](/developer_portal/contributing/overview)
- [Development Setup](/developer_portal/contributing/development-setup)
- [Your First PR](/developer_portal/contributing/submitting-pr)
### Extension Development
- [Extension Project Structure](/developer_portal/extensions/extension-project-structure)
- [Extension Architecture](/developer_portal/extensions/architecture)
- [Quick Start](/developer_portal/extensions/quick-start)
## 📚 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](https://apache-superset.slack.com)** - Join #development, #troubleshooting, or #beginners
- **[GitHub Discussions](https://github.com/apache/superset/discussions)** - Ask questions and share ideas
- **[Mailing Lists](https://lists.apache.org/list.html?dev@superset.apache.org)** - Development discussions
### Contribute
- **[Good First Issues](https://github.com/apache/superset/labels/good%20first%20issue)** - Start here!
- **[Help Wanted](https://github.com/apache/superset/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)** - Issues needing help
- **[Roadmap](https://github.com/orgs/apache/projects/180)** - See what's planned
## 📖 Additional Resources
### External Documentation
- **[User Documentation](https://superset.apache.org/docs/intro)** - Using Superset
- **[API Documentation](https://superset.apache.org/docs/api)** - REST API reference
- **[Configuration Guide](https://superset.apache.org/docs/configuration/configuring-superset)** - Setup and configuration
### Important Files
- **[CLAUDE.md](https://github.com/apache/superset/blob/master/CLAUDE.md)** - LLM development guide
- **[UPDATING.md](https://github.com/apache/superset/blob/master/UPDATING.md)** - Breaking changes log
## 🎯 Where to Start?
<table>
<tr>
<td width="50%">
**I want to contribute code**
1. [Set up development environment](/developer_portal/contributing/development-setup)
2. [Find a good first issue](https://github.com/apache/superset/labels/good%20first%20issue)
3. [Submit your first PR](/developer_portal/contributing/submitting-pr)
</td>
<td width="50%">
**I want to build an extension**
1. [Start with Quick Start](/developer_portal/extensions/quick-start)
2. [Learn extension structure](/developer_portal/extensions/extension-project-structure)
3. [Explore architecture](/developer_portal/extensions/architecture)
</td>
</tr>
<tr>
<td>
**I found a bug**
1. [Search existing issues](https://github.com/apache/superset/issues)
2. [Report the bug](/developer_portal/contributing/issue-reporting)
3. [Submit a fix](/developer_portal/contributing/submitting-pr)
</td>
<td>
**I need help**
1. [Check the FAQ](https://superset.apache.org/docs/frequently-asked-questions)
2. [Ask in Slack](https://apache-superset.slack.com)
3. [Start a discussion](https://github.com/apache/superset/discussions)
</td>
</tr>
</table>
---
Welcome to the Apache Superset community! We're excited to have you contribute. 🎉
Reference in New Issue View Git Blame Copy Permalink