You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "rusackas (via GitHub)" <gi...@apache.org> on 2025/12/19 09:01:27 UTC

[PR] feat(docs): add resources admonition with external links [superset]

rusackas opened a new pull request, #36761:
URL: https://github.com/apache/superset/pull/36761

   ## Summary
   
   Adds a custom `:::resources` admonition to the Superset documentation for linking to external resources (vendor docs, blogs, tutorials, videos). This creates a consistent, subtle way to surface additional learning materials throughout the docs.
   
   **Changes include:**
   - Custom `ResourcesAdmonition` component with bookmark icon
   - Subtle gray styling (light/dark mode support)
   - Registration of `resources` keyword in Docusaurus config
   - 50+ external resources added across 15 documentation pages
   
   ### Resources Added
   
   | Page | Resources |
   |------|-----------|
   | **databases.mdx** | ClickHouse, CrateDB, Trino, YugabyteDB, Elasticsearch, BigQuery, Hive, Oracle, PostgreSQL, Snowflake, Spark SQL, TimescaleDB vendor docs & blogs |
   | **quickstart.mdx** | Superset 101 video, getting started blog |
   | **theming.mdx** | Theming video, CSS customization blogs |
   | **exploring-data.mdx** | ECharts, drill-by, cross-filtering blogs |
   | **creating-your-first-dashboard.mdx** | Dashboard best practices, semantic layer |
   | **configuring-superset.mdx** | Feature flags blog |
   | **securing_superset.mdx** | Security vulnerabilities handling blog |
   | **api.mdx** | REST API and accessing APIs blogs |
   | **alerts-reports.mdx** | Slack/email alerts tutorials |
   | **kubernetes.mdx** | Helm deployment tutorials |
   | **cache.mdx** | Performance optimization blogs |
   
   ## BEFORE/AFTER
   
   **Before:** No consistent way to link external resources
   
   **After:** Subtle gray box with bookmark icon:
   ```
   ┌─────────────────────────────────────────────────┐
   │ 🔖 Additional Resources                         │
   │                                                 │
   │ • Video: Superset 101                           │
   │ • Blog: Getting Started with Apache Superset   │
   │ • Tutorial: Creating Your First Dashboard      │
   └─────────────────────────────────────────────────┘
   ```
   
   ## TESTING INSTRUCTIONS
   
   1. Build docs: `cd docs && npm run build`
   2. Serve: `npx serve build`
   3. Check any page with resources (e.g., /docs/quickstart)
   4. Verify gray styling in both light and dark mode
   
   ## ADDITIONAL INFORMATION
   
   - Sources include: Preset blogs, vendor documentation (ClickHouse, Trino, CrateDB, etc.), YouTube tutorials, and community blogs
   - All links verified as working and relevant to their respective documentation sections
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "codeant-ai-for-open-source[bot] (via GitHub)" <gi...@apache.org>.
codeant-ai-for-open-source[bot] commented on PR #36761:
URL: https://github.com/apache/superset/pull/36761#issuecomment-3712581460

   CodeAnt AI is running Incremental review
   
   ---
   
   ### Thanks for using CodeAnt! 🎉
   
   We're free for open-source projects. if you're enjoying it, help us grow by sharing.
   
   [Share on X](https://twitter.com/intent/tweet?text=Just%20tried%20%40CodeAntAI%20for%20automated%20code%20review%20and%20I%27m%20impressed%21%20Free%20for%20open%20source%20with%20a%20free%20trial%20for%20private%20repos.%20Worth%20checking%20out%3A&url=https%3A//codeant.ai) ·
   [Reddit](https://www.reddit.com/submit?title=Check%20out%20CodeAnt%20for%20automated%20code%20review&text=Just%20tried%20CodeAnt%20for%20automated%20code%20review%20and%20I%27m%20impressed%21%20Free%20for%20open%20source%20with%20a%20free%20trial%20for%20private%20repos.%20Worth%20checking%20out%3A%20https%3A//codeant.ai) ·
   [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcodeant.ai&mini=true&title=Check%20out%20CodeAnt%20for%20automated%20code%20review&summary=Just%20tried%20CodeAnt%20for%20automated%20code%20review%20and%20I%27m%20impressed%21%20Free%20for%20open%20source%20with%20a%20free%20trial%20for%20private%20repos)
   


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #36761:
URL: https://github.com/apache/superset/pull/36761#issuecomment-3712757435

   AI Code Review is in progress (usually takes 3 to 15 minutes unless it's a very large PR).
   
   <details>
   <summary>
   Bito Usage Guide
   </summary>
   
   **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 <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/available-commands" target="_blank" rel="noopener noreferrer">documentation</a> for additional commands.
         
   **Configuration**
   
   This repository uses `Superset` You can customize the agent settings <a href="https://alpha.bito.ai/home/ai-agents/code-review-agent" target="_blank" rel="noopener noreferrer">here</a> or contact your Bito workspace admin at evan@preset.io.
         
   **Documentation & Help**
   - <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/install-run-using-bito-cloud/create-or-customize-an-agent-instance" target="_blank" rel="noopener noreferrer">Customize agent settings</a>
   - <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/implementing-custom-code-review-rules" target="_blank" rel="noopener noreferrer">Review rules</a>
   - <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent" target="_blank" rel="noopener noreferrer">General documentation</a>
   - <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/faqs" target="_blank" rel="noopener noreferrer">FAQ</a>
   
   </details>
   


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #36761:
URL: https://github.com/apache/superset/pull/36761#issuecomment-3674183352

   AI Code Review is in progress (usually takes 3 to 15 minutes unless it's a very large PR).


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "codeant-ai-for-open-source[bot] (via GitHub)" <gi...@apache.org>.
codeant-ai-for-open-source[bot] commented on PR #36761:
URL: https://github.com/apache/superset/pull/36761#issuecomment-3674195449

   ## Nitpicks 🔍
   
   <table>
   <tr><td>🔒&nbsp;<strong>No security issues identified</strong></td></tr>
   <tr><td>⚡&nbsp;<strong>Recommended areas for review</strong><br><br>
   
   - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-b3e6185638da54ee29f1d54f4496274f5d92fcfe24d888feabd6e9e3cfec2bbbR19-R22'><strong>MDX/admonition parsing</strong></a><br>The new `:::resources` custom admonition block relies on the Docusaurus MDX parser and the project's custom container registration. Verify the custom container is registered and that this exact placement/format (no title on the same line, list syntax inside) renders correctly in both dev and production builds and in light/dark modes.<br>
   
   - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-f460a0f83b1402fc10a2ab0653f40aba549a2bbed08a971577db8b1a2b5248fcR84-R84'><strong>Custom Admonition Registration</strong></a><br>This file uses a custom admonition token `:::resources`. If the new admonition component/keyword is not properly registered in the Docusaurus MDX/remark pipeline, the docs build will either render incorrectly or fail. Verify the component name, the registration in Docusaurus config, and that the component is shipped with the site.<br>
   
   - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-c320155d4d1897c6db7537287db470fd88c9e9b3badaf7e62927a0d4dc9cb12bR102-R105'><strong>Admonition closure</strong></a><br>Several new `:::resources` admonitions were added. If any closing `:::` delimiters are indented or missing, the MDX/markdown may not render the admonition correctly (it can remain open or break the page layout). Verify every added admonition has a matching, non-indented closing `:::` on its own line.<br>
   
   - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-ebe2a1fa71cda5af30345b8c864766cffa2ee46562d22fe3093176c0b4e4961cR117-R121'><strong>Admonition registration</strong></a><br>The file now contains inline `:::resources` admonitions. Verify that the custom `resources` admonition is actually registered in the Docusaurus config and that the build pipeline recognizes this syntax. If the plugin/MDX remark is not registered, these blocks will render as plain text and not the intended styled component.<br>
   
   - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-62cd168bee744bbe1b2dd0f5b0941dfa6ca8432a9997c32d64eac06fe4b0d555R139-R142'><strong>Build failure risk</strong></a><br>The new `:::resources` custom admonition relies on a registered MDX/React component and Docusaurus config. If the custom admonition/component or its registration is missing or misconfigured, the docs build will fail. Verify the `ResourcesAdmonition` component exists and that `resources` is registered in the Docusaurus plugin/config.<br>
   
   </td></tr>
   </table>
   


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "codeant-ai-for-open-source[bot] (via GitHub)" <gi...@apache.org>.
codeant-ai-for-open-source[bot] commented on PR #36761:
URL: https://github.com/apache/superset/pull/36761#issuecomment-3674195661

   CodeAnt AI finished reviewing your PR.


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "rusackas (via GitHub)" <gi...@apache.org>.
rusackas merged PR #36761:
URL: https://github.com/apache/superset/pull/36761


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on code in PR #36761:
URL: https://github.com/apache/superset/pull/36761#discussion_r2634300964


##########
docs/docusaurus.config.ts:
##########
@@ -343,6 +351,10 @@ const config: Config = {
             return `https://github.com/apache/superset/edit/master/docs/${versionDocsDirPath}/${docPath}`;
           },
           remarkPlugins: [remarkImportPartial, remarkLocalizeBadges],
+          admonitions: {
+            keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'],
+            extendDefaults: true,
+          },

Review Comment:
   <div>
   
   
   <div id="suggestion">
   <div id="issue"><b>Missing Admonition Type for 'warning'</b></div>
   <div id="fix">
   
   The admonitions config adds 'warning' to keywords, but no corresponding AdmonitionType component exists in the theme, which may cause :::warning blocks (used in 10 docs files) to render without expected styling or icons, per Docusaurus docs requiring theme mapping for custom keywords.
   </div>
   
   
   </div>
   
   
   
   
   <small><i>Code Review Run #59406c</i></small>
   </div>
   
   ---
   Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
   - [ ] Yes, avoid them



##########
docs/docs/quickstart.mdx:
##########
@@ -80,3 +80,10 @@ From this point on, you can head on to:
 - [Installing on Kubernetes](/docs/installation/kubernetes/)
 
 Or just explore our [Documentation](https://superset.apache.org/docs/intro)!
+
+:::resources
+- [Video: Superset in 2 Minutes](https://www.youtube.com/watch?v=AqousXQ7YHw)
+- [Video: Superset 101](https://www.youtube.com/watch?v=mAIH3hUoxEE)
+- [Blog: Getting Started with Apache Superset](https://preset.io/blog/apache-superset-quick-start/)

Review Comment:
   <div>
   
   
   <div id="suggestion">
   <div id="issue"><b>Broken external link</b></div>
   <div id="fix">
   
   The link to the Preset blog post returns a 404 error, which could frustrate users seeking quick-start guidance. Consider updating to a current Preset resource on Superset getting started, or removing this entry.
   </div>
   
   
   </div>
   
   
   
   
   <small><i>Code Review Run #59406c</i></small>
   </div>
   
   ---
   Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
   - [ ] Yes, avoid them



##########
docs/docusaurus.config.ts:
##########
@@ -70,6 +74,10 @@ if (!versionsConfig.developer_portal.disabled) {
       editUrl:
         'https://github.com/apache/superset/edit/master/docs/developer_portal',
       remarkPlugins: [remarkImportPartial, remarkLocalizeBadges],
+      admonitions: {
+        keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'],
+        extendDefaults: true,
+      },

Review Comment:
   <div>
   
   
   <div id="suggestion">
   <div id="issue"><b>Missing Admonition Type for 'warning'</b></div>
   <div id="fix">
   
   The admonitions config adds 'warning' to keywords, but no corresponding AdmonitionType component exists in the theme, which may cause :::warning blocks (used in 10 docs files) to render without expected styling or icons, per Docusaurus docs requiring theme mapping for custom keywords.
   </div>
   
   
   </div>
   
   
   
   
   <small><i>Code Review Run #59406c</i></small>
   </div>
   
   ---
   Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
   - [ ] Yes, avoid them



##########
docs/docusaurus.config.ts:
##########
@@ -46,6 +46,10 @@ if (!versionsConfig.components.disabled) {
       editUrl:
         'https://github.com/apache/superset/edit/master/docs/components',
       remarkPlugins: [remarkImportPartial, remarkLocalizeBadges],
+      admonitions: {
+        keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'],
+        extendDefaults: true,
+      },

Review Comment:
   <div>
   
   
   <div id="suggestion">
   <div id="issue"><b>Missing Admonition Type for 'warning'</b></div>
   <div id="fix">
   
   The admonitions config adds 'warning' to keywords, but no corresponding AdmonitionType component exists in the theme, which may cause :::warning blocks (used in 10 docs files) to render without expected styling or icons, per Docusaurus docs requiring theme mapping for custom keywords.
   </div>
   
   
   </div>
   
   
   
   
   <small><i>Code Review Run #59406c</i></small>
   </div>
   
   ---
   Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
   - [ ] Yes, avoid them



-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org


Re: [PR] feat(docs): add resources admonition with external links [superset]

Posted by "codeant-ai-for-open-source[bot] (via GitHub)" <gi...@apache.org>.
codeant-ai-for-open-source[bot] commented on PR #36761:
URL: https://github.com/apache/superset/pull/36761#issuecomment-3674183144

   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](https://twitter.com/intent/tweet?text=Just%20tried%20%40CodeAntAI%20for%20automated%20code%20review%20and%20I%27m%20impressed%21%20Free%20for%20open%20source%20with%20a%20free%20trial%20for%20private%20repos.%20Worth%20checking%20out%3A&url=https%3A//codeant.ai) ·
   [Reddit](https://www.reddit.com/submit?title=Check%20out%20CodeAnt%20for%20automated%20code%20review&text=Just%20tried%20CodeAnt%20for%20automated%20code%20review%20and%20I%27m%20impressed%21%20Free%20for%20open%20source%20with%20a%20free%20trial%20for%20private%20repos.%20Worth%20checking%20out%3A%20https%3A//codeant.ai) ·
   [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcodeant.ai&mini=true&title=Check%20out%20CodeAnt%20for%20automated%20code%20review&summary=Just%20tried%20CodeAnt%20for%20automated%20code%20review%20and%20I%27m%20impressed%21%20Free%20for%20open%20source%20with%20a%20free%20trial%20for%20private%20repos)
   


-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org