Skip to content

[Doc-18078] document improvement#18079

Open
SbloodyS wants to merge 9 commits intoapache:devfrom
SbloodyS:doc_18078
Open

[Doc-18078] document improvement#18079
SbloodyS wants to merge 9 commits intoapache:devfrom
SbloodyS:doc_18078

Conversation

@SbloodyS
Copy link
Member

@SbloodyS SbloodyS commented Mar 18, 2026

Was this PR generated or assisted by AI?

Yes.

Purpose of the pull request

fix #18078

Brief change log

  • Adding the missing data source documents in Chinese
  • Clean up TODO comments
  • Optimizing Chinese Quick Start Documents
  • Correcting Kubernetes document
  • Update the document contribution guide

Verify this pull request

This pull request is code cleanup without any test coverage.

(or)

This pull request is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(or)

Pull Request Notice

Pull Request Notice

If your pull request contains incompatible change, you should also add it to docs/docs/en/guide/upgrade/incompatible.md

@SbloodyS SbloodyS requested a review from EricGao888 as a code owner March 18, 2026 06:41
@SbloodyS SbloodyS added the improvement make more easy to user or prompt friendly label Mar 18, 2026
@SbloodyS SbloodyS added this to the 3.4.2 milestone Mar 18, 2026
ruanwenjun
ruanwenjun previously approved these changes Mar 19, 2026
Copy link
Member

@ruanwenjun ruanwenjun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ruanwenjun ruanwenjun requested a review from Copilot March 19, 2026 14:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves Apache DolphinScheduler documentation by cleaning up outdated TODO comment blocks in task docs, refining Chinese quick-start and task documentation wording, fixing a Kubernetes install doc detail, and adding missing Chinese datasource docs.

Changes:

  • Removed repeated TODO/commented-anchor blocks from many EN/ZH task documentation pages.
  • Refined multiple Chinese docs (Quick Start, task pages, contribution guide) for clarity and consistency.
  • Added new Chinese datasource pages (SQL Server, Presto, DB2, ClickHouse) and corrected Spark version text in the Kubernetes installation guide.

Reviewed changes

Copilot reviewed 73 out of 73 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/docs/zh/guide/task/zeppelin.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/switch.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/sub-workflow.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/stored-procedure.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/sqoop.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/sql.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/spark.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/shell.md Cleans up formatting and improves Chinese wording for Shell task doc.
docs/docs/zh/guide/task/seatunnel.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/sagemaker.md Removes obsolete TODO/commented anchor block in task example/parameters section.
docs/docs/zh/guide/task/remoteshell.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/python.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/openmldb.md Removes obsolete TODO/commented anchor block in task example/parameters section.
docs/docs/zh/guide/task/mlflow.md Removes obsolete TODO/commented anchor block in task example/parameters section.
docs/docs/zh/guide/task/map-reduce.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/linkis.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/kubernetes.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/jupyter.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/java.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/http.md Improves default-parameter reference formatting and Chinese wording/punctuation.
docs/docs/zh/guide/task/hive-cli.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/grpc.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/flink.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/emr.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/dvc.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/dms.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/dinky.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/dependent.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/datax.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/datasync.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/datafactory.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/conditions.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/task/chunjun.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/zh/guide/start/quick-start.md Rewrites/normalizes Chinese quick start wording and formatting.
docs/docs/zh/guide/installation/kubernetes.md Corrects Spark binary version reference in Kubernetes installation doc.
docs/docs/zh/guide/datasource/sqlserver.md Adds missing Chinese SQL Server datasource documentation.
docs/docs/zh/guide/datasource/presto.md Adds missing Chinese Presto datasource documentation.
docs/docs/zh/guide/datasource/db2.md Adds missing Chinese DB2 datasource documentation.
docs/docs/zh/guide/datasource/clickhouse.md Adds missing Chinese ClickHouse datasource documentation.
docs/docs/zh/contribute/join/document.md Updates Chinese documentation contribution guide wording/formatting.
docs/docs/en/guide/task/zeppelin.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/switch.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/sub-workflow.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/stored-procedure.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/sqoop.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/sql.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/spark.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/shell.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/seatunnel.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/sagemaker.md Removes obsolete TODO/commented anchor block in task example/parameters section.
docs/docs/en/guide/task/remoteshell.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/python.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/openmldb.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/mlflow.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/map-reduce.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/linkis.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/kubernetes.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/jupyter.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/java.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/http.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/hive-cli.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/grpc.md Partially removes TODO block, leaving a stale commented reference that needs cleanup.
docs/docs/en/guide/task/flink.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/emr.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/dvc.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/dms.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/dinky.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/dependent.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/datax.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/datasync.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/datafactory.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/conditions.md Removes obsolete TODO/commented anchor block in task parameters section.
docs/docs/en/guide/task/chunjun.md Removes obsolete TODO/commented anchor block in task parameters section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

SbloodyS and others added 2 commits March 19, 2026 22:40
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

document improvement make more easy to user or prompt friendly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Document improvement

3 participants