michael-s-molina opened a new pull request, #36005:
URL: https://github.com/apache/superset/pull/36005
### SUMMARY
This PR comprehensively reorganizes and rewrites the Apache Superset
developer portal documentation to improve navigation, accuracy, and usability.
The changes focus on the Extensions section, with corrections to the Quick
Start guide based on an actual extension implementation and CLI tool behavior.
### Documentation Structure Reorganization
**Renamed Pages:**
- `testing/overview.md`: "Testing Overview" → "Overview"
- `extensions/overview.md`: "Extensions Overview" → "Overview"
- `contributing/overview.md`: "Contributing Overview" → "Overview" (H1:
"Contributing")
**Navigation Updates:**
- Moved "Contributing" section before "Extensions" in navigation (Order:
Overview → Contributing → Extensions → Testing)
- Renamed "Contributing to Superset" → "Contributing" in sidebar
**Merged Documentation:**
- Combined `architectural-principles.md` and `high-level-architecture.md`
into single `extensions/architecture.md` page
- Merged `dynamic-module-loading.md` content into Architecture page as a
subsection
- Renamed and repositioned `proof-of-concept.md` → `quick-start.md`
(sidebar_position: 2, right after Overview)
**Removed Pages:**
- `extensions/built-in-features.md` - "What This Means for Superset's
Built-in Features"
- `extensions/versioning.md` - "Versioning"
- `extensions/lifecycle-management.md` - "Lifecycle and Management"
- `extensions/dynamic-module-loading.md` - Merged into Architecture
**Updated Configuration:**
- `docs/developer_portal/sidebars.js` - Updated navigation order and removed
deleted pages
- `docs/sidebarTutorials.js` - Updated navigation order and removed deleted
pages
- `docs/developer_portal/index.md` - Updated all internal links to point to
new locations
### Complete Rewrite: Quick Start Guide
The Quick Start guide (`extensions/quick-start.md`) was completely rewritten
based on:
- Actual `superset-extensions` CLI tool behavior (tested with pyenv)
- Implementation patterns from a real extension
- Correct deployment workflow
### TESTING INSTRUCTIONS
**Build the docs locally:**
```bash
cd docs
yarn install
yarn start
```
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in
[SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
