apache/dolphinscheduler

[Feature] Add Kapa.ai docs assistant integration to DolphinScheduler

Open

#17775 opened on Dec 8, 2025

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Java (11,659 stars) (4,324 forks)batch import
documentgood first issue

Description

Search before asking

  • I had searched in the issues and found no similar issues.

What happened

We already applied for and got access to Kapa.ai for the DolphinScheduler project. I’d like to propose that we integrate the Kapa.ai documentation assistant into our docs of https://github.com/apache/dolphinscheduler-website

Previously, DolphinScheduler had a corresponding PR. However, at that time, the act of connecting to the AI Q&A was not approved by ASF, so the PR was rolled back. You can refer to that PR.

Why

  • DolphinScheduler has a lot of concepts and configuration options.
  • New users often ask repeated “how to configure X / why does Y fail” questions.
  • A docs-grounded AI assistant can help users find answers faster and reduce basic Q&A.

What needs to be done

Docs site integration

  • Embed the Kapa “Ask AI” widget <script> snippet into the official documentation site layout, so users can ask questions on any docs page.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor guide

Tech stack
htmljavascript
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic HTML/JSFamiliarity with DolphinScheduler website repo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests embedding the Kapa.ai 'Ask AI' widget snippet into the DolphinScheduler documentation site. The relevant repository is https://github.com/apache/dolphinscheduler website. Look for the main layout file (e.g., layout.html or App.js) where the script tag can be added. The previous PR (referenced in the issue) provides a starting point, but ensure the integration complies with ASF policies. The widget should appear on all documentation pages, so place the snippet in a global template. No additional dependencies are required beyond the snippet provided by Kapa.ai.