superset icon indicating copy to clipboard operation
superset copied to clipboard

docs: add inTheWild (json,react docusaurus) onto home page

Open javacatknight opened this issue 3 weeks ago โ€ข 11 comments

User description

SUMMARY

In regards to the https://github.com/apache/superset/discussions/36384. This PR adds the json file, some sample logos (with permission), and a new docusaurus page to display superset users from inthewild.md, with a style similar to the index.tsx / home page.

Deeper write up - https://hackmd.io/@aIYQFnuRSwG7sBiDqjw7Yg/H1VQn0nbWl Next steps - https://hackmd.io/@aIYQFnuRSwG7sBiDqjw7Yg/HJ0GA1pW-x

CHANGELOG: add /experimental/parse.js (txt/md -> JSON) (for the purpose of locally regenerating the json if needed) add new directory /logos to /docs/static/img/logos added sample logos (svg, png) add inTheWild.js (json results a js obj) to docs/static/resources add inTheWild.tsx, new docusarus (frontend) page inTheWild to docs/src/pages and updated route in the dinosaurus.config.ts file

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Preview images image (3) image (2) image (1) img3

TESTING INSTRUCTIONS

https://superset.apache.org/docs/6.0.0/contributing/howtos#contributing-to-documentation

ADDITIONAL INFORMATION

  • [ ] Has associated issue:
  • [ ] Required feature flags:
  • [x ] 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

Highlight real-world Superset users in the documentation

What Changed

  • Added a new "In the Wild" docs page that shows organizations using Superset, grouped by sector, with logos and links to their sites
  • Added an "In the Wild" item to the documentation navigation so visitors can quickly find the Superset user gallery
  • Included a clear call-to-action linking to the INTHEWILD.md file so organizations can easily add themselves to the list

Impact

โœ… Easier discovery of real-world Superset adopters โœ… Stronger social proof for teams evaluating Superset โœ… Simpler path for organizations to showcase their Superset usage

๐Ÿ’ก 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.

javacatknight avatar Dec 02 '25 22:12 javacatknight

CodeAnt AI is reviewing your PR.

Nitpicks ๐Ÿ”

๐Ÿ”’ย No security issues identified
โšกย Recommended areas for review

  • [ ] Security Issue
    External links use target="_blank" with rel="noreferrer" only. Without noopener, this can expose the page to reverse tabnabbing via window.opener. This applies both to the GitHub "Add your name/org!" link and the per-user/org links in the cards.

  • [ ] Possible Bug
    The inner loop that reads entries under a category indexes looping_through_line[0] without first checking for an empty string or missing lines, which can trigger an IndexError when a category has no entries or when malformed input is encountered. The loop condition and body should defensively handle empty lines/EOF before indexing.

CodeAnt AI finished reviewing your PR.

You can add docs/static/img/* to the .rat-excluded file to skip the license header checks on those files, but you'll still need to add the ASF blurb at the top of docs/src/resources/experimental/parse-md-to-json.py... if that's no longer 'experimental' ;)

rusackas avatar Dec 02 '25 23:12 rusackas

CodeAnt AI is running Incremental review

Committed a change to .rat-excludes that might resolve that CI step.

rusackas avatar Dec 03 '25 18:12 rusackas

I'm going to fix/do the pre-commit checks locally but regarding the license check, it's interesting that the rat check passed on the .png file in the directory, but not the .svg files.

javacatknight avatar Dec 03 '25 23:12 javacatknight

CodeAnt AI is running Incremental review

I'm going to fix/do the pre-commit checks locally but regarding the license check, it's interesting that the rat check passed on the .png file in the directory, but not the .svg files.

I ended up adding docs/static/img/logos/.*svg because for whatever reason, docs/static/img/logos/* only worked for the png file. Just commenting this for your interest

Sorry about all the comments! Will definitely work with pre-commit more in the future ๐Ÿ˜Š

javacatknight avatar Dec 04 '25 05:12 javacatknight

CodeAnt AI is running Incremental review

Made it nicer looking!

And for fun/your interest, regarding:

  • [ ] Security IssueExternal links use target="_blank" with rel="noreferrer" only. Without noopener, this can expose the page to reverse tabnabbing via window.opener. This applies both to the GitHub "Add your name/org!" link and the per-user/org links in the cards.

noreferrer now includes noopener - https://html.spec.whatwg.org/multipage/links.html#link-type-noreferrer

javacatknight avatar Dec 04 '25 07:12 javacatknight

CodeAnt AI is running Incremental review

CodeAnt AI is running Incremental review

CodeAnt AI is running Incremental review

Hey @javacatknight! ๐Ÿ‘‹ I made some enhancements to your PR. Here's a summary of the changes:

Data Structure Simplification

  • Replaced the markdown + parser approach with a single YAML source file (RESOURCES/INTHEWILD.yaml)
  • Contributors can now just edit the YAML directly - much simpler!
  • Added TypeScript type declarations for YAML imports

In the Wild Page Improvements

  • Refactored to use AntD components (Card, Collapse, Avatar, Row, Col, Typography)
  • Added contributor facepiles with clickable GitHub avatars showing who from each org contributes
  • Responsive grid layout for companies without logos
  • All collapse sections open by default
  • Direct "Add your org" link opens YAML in GitHub edit mode

Homepage Integration

  • Added "Trusted by teams everywhere" carousel section below the databases
  • Shows company logos using AntD Card + Carousel components
  • Fisher-Yates shuffle on page load for fair rotation (each visitor sees different order)
  • Links to full In the Wild page and YAML edit

Navigation Updates

  • Moved "In the Wild" into the Community Resources dropdown
  • Added Community Calendar link
  • Updated README links to point to the website instead of markdown files

Let me know if you have any questions or want any adjustments!

rusackas avatar Dec 16 '25 18:12 rusackas

I'm thinking my next/last move here might be to remove the logos. You've done a great job at proving this all works!!!

Now, I'm just worried about trademark/copyright stuff. I'm thinking I'll remove the logos, and have the front page carousel only show if there are more than, say... 8 logos populated. Then the In the Wild page can show all text-based cards when we merge this.

The next step then, would be to reach out to anyone who's touched the In the Wild page in the past, and ask them to add their logo (and any other contributors at that company). I can seed it with a few (i.e. Preset, Airbnb, maybe a few others). Then, anyone who adds a logo would be giving implicit permission by opening their PR.

Let me know what you think! Happy to add screenshots of all this and update the PR description if you'd like. Really appreciate your work on this.... you made it easy to just tweak it and smooth out some things. I appreciate all the work!

rusackas avatar Dec 16 '25 18:12 rusackas

One more update: the homepage carousel section now only displays when there are more than 10 logos available.

This prepares for a follow-up where we can remove the existing logo files and logo: entries from the YAML. Contributors can then re-add their logos via PR, which establishes implicit consent for the ASF to display them.

Once enough logos are added back (>10), the carousel will automatically reappear on the homepage.

rusackas avatar Dec 16 '25 22:12 rusackas

Please disregard the force push - I've messed up the commit history, that's not correct at all

javacatknight avatar Dec 16 '25 23:12 javacatknight

CodeAnt AI is running Incremental review

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 ยท Reddit ยท LinkedIn