-
Notifications
You must be signed in to change notification settings - Fork 16.3k
docs(extensions): Add community extensions registry page #36312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(extensions): Add community extensions registry page #36312
Conversation
Code Review Agent Run #ccec70Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help |
|
Love this! If we want to lower the friction, we COULD use the superset.committers gmail to create a Google Form, which lands in a public GSheet. That sheet could have an "approved" checkbox column, and we could build this page dynamically from there. Not sure if that would make life easier for people to contribute their extensions... the more, the merrier, I think. |
|
|
||
| | Name | Description | Author | Preview | | ||
| |------|-------------|--------|---------| | ||
| | [Query Insights](https://github.com/example/superset-query-insights) | A SQL Lab extension that displays metadata and data quality information about tables referenced in your queries. Shows table descriptions, data quality scores, latest partition dates, data retention policies, team ownership, and example queries. | Michael S. Molina | <a href="/img/extensions/example.png" target="_blank"><img src="/img/extensions/example.png" alt="Query Insights" width="120" /></a> | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we maintain a real branch for the example extension? Having a link to a 404 page will likely not be a great experience.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I developed two extensions that I'm planning to host on my personal repository:
- An extension that exports SQL Lab results to Google Sheets
- An extension that display core API events
My plan is to replace the Query Insights example with those (task). I only added the Query Insights so we can see how this page will look like in the future. I think we can merge this PR and open a follow-up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@villebro I updated the extensions list and replaced Query Insights with Extensions API Explorer.
villebro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a few optional suggestions for the linked extension/repo
|
|
||
| | Name | Description | Author | Preview | | ||
| | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [Extensions API Explorer](https://github.com/michael-s-molina/superset-extensions/tree/main/api_explorer) | A SQL Lab panel that demonstrates the Extensions API by providing an interactive explorer for testing commands like getTabs, getCurrentTab, and getDatabases. Useful for extension developers to understand and experiment with the available APIs. | Michael S. Molina | <a href="/img/extensions/api_explorer.png" target="_blank"><img src="/img/extensions/api_explorer.png" alt="Extensions API Explorer" width="120" /></a> | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice - as a follow up, it could be nice to add a README to the the linked extension to give some more context on it. Also maybe removing the dist folder and replace it with a bundled up supx as a proper GitHub release instead of having the dist committed in the repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
SUMMARY
Adds a new documentation page that serves as a registry of community-created Superset extensions. This page allows community members to share their extensions by submitting PRs to add them to the registry.
Key features:
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
When clicking on a thumbnail:

TESTING INSTRUCTIONS
cd docs && npm run startADDITIONAL INFORMATION