diff --git a/README.md b/README.md index e6dd708623d..e40a0b572b9 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,16 @@ under the License. A modern, enterprise-ready business intelligence web application. +### Documentation + +- **[User Guide](https://superset.apache.org/user-docs/)** — For analysts and business users. Explore data, build charts, create dashboards, and connect databases. +- **[Administrator Guide](https://superset.apache.org/admin-docs/)** — Install, configure, and operate Superset. Covers security, scaling, and database drivers. +- **[Developer Guide](https://superset.apache.org/developer-docs/)** — Contribute to Superset or build on its REST API and extension framework. + [**Why Superset?**](#why-superset) | [**Supported Databases**](#supported-databases) | -[**Installation and Configuration**](#installation-and-configuration) | [**Release Notes**](https://github.com/apache/superset/blob/master/RELEASING/README.md#release-notes-for-recent-releases) | [**Get Involved**](#get-involved) | -[**Contributor Guide**](#contributor-guide) | [**Resources**](#resources) | [**Organizations Using Superset**](https://superset.apache.org/inTheWild) @@ -191,7 +195,7 @@ Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) gu ## Contributor Guide Interested in contributing? Check out our -[Developer Portal](https://superset.apache.org/developer_portal/) +[Developer Guide](https://superset.apache.org/developer-docs/) to find resources around contributing along with a detailed guide on how to set up a development environment. diff --git a/docs/admin_docs/index.md b/docs/admin_docs/index.md index c841ac113c2..8b1c1de4b1a 100644 --- a/docs/admin_docs/index.md +++ b/docs/admin_docs/index.md @@ -38,5 +38,5 @@ This section contains documentation for system administrators and operators who ## Looking for something else? -- **[User Documentation](/user-docs/intro)** - Guides for analysts and business users +- **[User Documentation](/user-docs/)** - Guides for analysts and business users - **[Developer Documentation](/developer-docs)** - Contributing, extensions, and development guides diff --git a/docs/developer_docs/index.md b/docs/developer_docs/index.md index a1ffc18d23c..fb2de2c70a1 100644 --- a/docs/developer_docs/index.md +++ b/docs/developer_docs/index.md @@ -26,7 +26,7 @@ under the License. Welcome to the Apache Superset Developer Portal - your comprehensive resource for contributing to and extending Apache Superset. -## 🚀 Quick Start +## Quick Start ### New Contributors - [Contributing Overview](/developer-docs/contributing/overview) @@ -38,7 +38,7 @@ Welcome to the Apache Superset Developer Portal - your comprehensive resource fo - [Extension Architecture](/developer-docs/extensions/architecture) - [Quick Start](/developer-docs/extensions/quick-start) -## 📚 Documentation Sections +## 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. @@ -49,7 +49,7 @@ Comprehensive testing strategies for Superset development. This section covers f ### 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 +## Development Resources ### Prerequisites - **Python**: 3.9, 3.10, or 3.11 @@ -66,7 +66,7 @@ Everything you need to contribute to the Apache Superset project. This section i - **Testing**: Jest, Pytest, Playwright - **CI/CD**: GitHub Actions, pre-commit -## 🤝 Community +## Community ### Get Help - **[Slack](https://apache-superset.slack.com)** - Join #development, #troubleshooting, or #beginners @@ -78,7 +78,7 @@ Everything you need to contribute to the Apache Superset project. This section i - **[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 +## Additional Resources ### External Documentation - **[User Documentation](https://superset.apache.org/docs/intro)** - Using Superset @@ -89,7 +89,7 @@ Everything you need to contribute to the Apache Superset project. This section i - **[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? +## Where to Start? @@ -132,4 +132,4 @@ Everything you need to contribute to the Apache Superset project. This section i --- -Welcome to the Apache Superset community! We're excited to have you contribute. 🎉 +Welcome to the Apache Superset community! We're excited to have you contribute. diff --git a/docs/docs/intro.md b/docs/docs/index.md similarity index 100% rename from docs/docs/intro.md rename to docs/docs/index.md diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 629b0249515..abcf6e34c2b 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -385,7 +385,7 @@ const config: Config = { from: '/installation.html', }, { - to: '/user-docs/intro', + to: '/user-docs/', from: '/tutorials.html', }, { @@ -405,7 +405,7 @@ const config: Config = { from: '/sqllab.html', }, { - to: '/user-docs/intro', + to: '/user-docs/', from: '/gallery.html', }, { @@ -449,9 +449,13 @@ const config: Config = { from: '/docs/contributing/hooks-and-linting', }, { - to: '/user-docs/intro', + to: '/user-docs/', from: '/docs/roadmap', }, + { + to: '/user-docs/', + from: '/user-docs/intro', + }, { to: '/developer-docs/contributing/overview', from: '/docs/contributing/contribution-guidelines', @@ -732,7 +736,7 @@ const config: Config = { const items = await defaultCreateSitemapItems(rest); return items.map((item) => { // Boost priority for key pages - if (item.url.includes('/user-docs/intro')) { + if (item.url.endsWith('/user-docs/')) { return { ...item, priority: 1.0, changefreq: 'daily' }; } if (item.url.includes('/user-docs/quickstart')) { @@ -801,13 +805,13 @@ const config: Config = { // Users docs - mirrors sidebar structure { label: 'Users', - to: '/user-docs/intro', + to: '/user-docs/', position: 'left', activeBaseRegex: '^/user-docs/', items: [ { type: 'doc', - docId: 'intro', + docId: 'index', label: 'Overview', }, { @@ -871,7 +875,7 @@ const config: Config = { ], }, { - href: '/user-docs/intro', + href: '/user-docs/', position: 'right', className: 'default-button-theme get-started-button', label: 'Get Started', diff --git a/docs/sidebars.js b/docs/sidebars.js index b5ae09dc626..fa7c7c5ef53 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -27,7 +27,7 @@ const sidebars = { { type: 'doc', label: 'Overview', - id: 'intro', + id: 'index', }, { type: 'doc', diff --git a/docs/src/data/databases.json b/docs/src/data/databases.json index 69cfc19fc3e..18eac0ddf34 100644 --- a/docs/src/data/databases.json +++ b/docs/src/data/databases.json @@ -1,5 +1,5 @@ { - "generated": "2026-02-26T00:43:40.570Z", + "generated": "2026-02-26T01:18:11.347Z", "statistics": { "totalDatabases": 72, "withDocumentation": 72, diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 86e485ec478..dba54bc6065 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -109,8 +109,7 @@ const docSections = [ description: 'For analysts and business users. Learn to explore data, build charts, create dashboards, and connect to databases.', cta: 'Browse User Docs', - href: '/user-docs/intro', - icon: '📊', + href: '/user-docs/', accent: '#20a7c9', }, { @@ -119,7 +118,6 @@ const docSections = [ 'For teams installing and operating Superset. Covers installation, configuration, security, and database drivers.', cta: 'Browse Admin Docs', href: '/admin-docs/', - icon: '⚙️', accent: '#457f8d', }, { @@ -128,7 +126,6 @@ const docSections = [ 'For contributors and engineers building on Superset. Covers the REST API, extensions, and contributing workflows.', cta: 'Browse Developer Docs', href: '/developer-docs/', - icon: '🛠️', accent: '#2d6a4f', }, { @@ -137,7 +134,6 @@ const docSections = [ 'Join the Superset community. Find resources on Slack, GitHub, the mailing list, and upcoming meetups.', cta: 'Join the Community', href: '/community', - icon: '🤝', accent: '#6d4c7e', }, ]; @@ -332,6 +328,12 @@ interface StyledDocSectionCardProps { accent: string; } +const StyledDocSectionsHeader = styled('div')` + & > div { + max-width: 960px; + } +`; + const StyledDocSectionsGrid = styled('div')` display: grid; grid-template-columns: repeat(4, minmax(0, 1fr)); @@ -367,11 +369,6 @@ const StyledDocSectionCard = styled(Link)` text-decoration: none; color: var(--ifm-font-base-color); } - .card-icon { - font-size: 32px; - line-height: 1; - margin-bottom: 14px; - } .card-title { font-size: 20px; font-weight: 700; @@ -736,17 +733,16 @@ export default function Home(): JSX.Element { - + + + - {docSections.map(({ title, description, cta, href, icon, accent }) => ( + {docSections.map(({ title, description, cta, href, accent }) => ( -

{title}

{description}

{cta} →