apache/dolphinscheduler

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

Open

#17,775 创建于 2025年12月8日

在 GitHub 查看
 (3 评论) (0 反应) (1 负责人)Java (11,659 star) (4,324 fork)batch import
documentgood first issue

描述

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

贡献者指南

技术栈
htmljavascript
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Basic HTML/JSFamiliarity with DolphinScheduler website repo
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.