Skip to content

docs: Adds a new "Dependencies" page to the Developer Portal#36817

Merged
rusackas merged 1 commit intoapache:masterfrom
michael-s-molina:add-dependencies-page
Dec 23, 2025
Merged

docs: Adds a new "Dependencies" page to the Developer Portal#36817
rusackas merged 1 commit intoapache:masterfrom
michael-s-molina:add-dependencies-page

Conversation

@michael-s-molina
Copy link
Member

@michael-s-molina michael-s-molina commented Dec 23, 2025

User description

SUMMARY

Adds a new "Dependencies" documentation page to the Developer Portal extensions section. This page helps extension developers understand:

  • The difference between stable public APIs (@apache-superset/core and apache-superset-core) with semantic versioning vs internal Superset code that can change without notice
  • When using internal dependencies may be acceptable (e.g., while the public API is evolving)
  • The architectural principle that Superset does not provide abstractions on top of core dependencies like React or SQLAlchemy - extension developers should use these libraries directly
  • That Superset UI components from @apache-superset/core/ui should be preferred over raw Ant Design for visual consistency
  • Future plans to maintain a CHANGELOG once the extensions API reaches v1

TESTING INSTRUCTIONS

Check the Developer Portal.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • 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

CodeAnt-AI Description

Add Dependencies page to Developer Portal and update Extensions navigation

What Changed

  • Added a new "Dependencies" documentation page that explains the difference between stable public APIs and unstable internal code, recommends when to use core packages, and lists best practices for extension authors
  • Added the new page to the Extensions section navigation and updated sidebar positions so the Dependencies page appears in the Extensions table of contents and related pages link to it
  • Updated Extensions overview and architecture pages to reference the new Dependencies guidance

Impact

✅ Clearer extension dependency guidance
✅ Fewer unexpected breakages when upgrading Superset
✅ Easier discovery of dependency rules in the Developer Portal

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@codeant-ai-for-open-source
Copy link
Contributor

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@bito-code-review
Copy link
Contributor

bito-code-review bot commented Dec 23, 2025

Code Review Agent Run #9eb738

Actionable Suggestions - 0
Review Details
  • Files reviewed - 2 · Commit Range: 20c8784..20c8784
    • docs/developer_portal/sidebars.js
    • docs/sidebarTutorials.js
  • Files skipped - 9
    • docs/developer_portal/extensions/architecture.md - Reason: Filter setting
    • docs/developer_portal/extensions/contribution-types.md - Reason: Filter setting
    • docs/developer_portal/extensions/dependencies.md - Reason: Filter setting
    • docs/developer_portal/extensions/deployment.md - Reason: Filter setting
    • docs/developer_portal/extensions/development.md - Reason: Filter setting
    • docs/developer_portal/extensions/mcp.md - Reason: Filter setting
    • docs/developer_portal/extensions/overview.md - Reason: Filter setting
    • docs/developer_portal/extensions/registry.md - Reason: Filter setting
    • docs/developer_portal/extensions/security.md - Reason: Filter setting
  • Tools
    • Eslint (Linter) - ✔︎ Successful
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@michael-s-molina michael-s-molina moved this from To Do to In Review in Superset Extensions Dec 23, 2025
@dosubot dosubot bot added the doc:developer Developer documentation label Dec 23, 2025
@codeant-ai-for-open-source codeant-ai-for-open-source bot added the size:L This PR changes 100-499 lines, ignoring generated files label Dec 23, 2025
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Dec 23, 2025
@codeant-ai-for-open-source
Copy link
Contributor

CodeAnt AI finished reviewing your PR.

@apache apache deleted a comment from codeant-ai-for-open-source bot Dec 23, 2025
@rusackas rusackas merged commit ba8d6eb into apache:master Dec 23, 2025
75 of 79 checks passed
@github-project-automation github-project-automation bot moved this from In Review to Done in Superset Extensions Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc:developer Developer documentation doc Namespace | Anything related to documentation size/L size:L This PR changes 100-499 lines, ignoring generated files

Projects

Development

Successfully merging this pull request may close these issues.

2 participants