apache/dolphinscheduler

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

Open

#17,775 opened on 2025年12月8日

GitHub で見る
 (3 comments) (0 reactions) (1 assignee)Java (11,659 stars) (4,324 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.