Skip to main content
FOSDEM PWA

How Apache Superset reinvented (and re-engineered) its world documentation

UD2.208 (Decroly) | Day 1 | 16:30 - 16:55 | Speakers: Evan Rusackas

How Apache Superset reinvented (and re-engineered) its world documentation
A picture of a devroom at FOSDEM 2024
Open in browser

Notes

Abstract

The addition of a new Extensions SDK in Superset led to a new initiative: a Developer Portal.

That, in turn, gave us the chance to re-imagine how we WANT our docs to work: • Bringing in scattered readmes/wikis/etc. under one roof • Creating independently versioned areas for different release cycles and intents • Automating screenshots and content to "keep up" with the codebase • Bringing API docs, React Story book, and more into a centralized interactive portal • Leveraging AI to build and maintain docs... for people AND for humans • Syndicating content from third party sources to be the end-all-be-all of Superset documentation • Leveraging AI (for free!) to provide chat-based support AND learn where our docs are falling short from the result

We've learned a lot of hard lessons over the years, and we're happy to share the process, ideas, and tools we've used to take things to the next level.

Speakers

Evan Rusackas

Evan is a community lead and software engineer with Preset, Inc. and works closely with the Apache Superset community. Evan's interests lie in UI design, data visualization, and frontend engineering. He spends the bulk of his time growing and engaging with the Superset community, striving to improve the product and its processes. When not working on software, he's a dad, a bassist, a beer judge, and an enthusiast of time well-spent in a garage.

Notice: The placeholder video image is licensed under CC BY-SA 4.0. The original image can be found hereChanges made to the image are: Cropped the image to a new ratio, part of the image was cut off.