This is an automated email from the ASF dual-hosted git repository.
wenjun pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new ff3a9c0801 [Doc-17327] Add helm section in development documentation
in both Chinese and English (#17335)
ff3a9c0801 is described below
commit ff3a9c08013f86c2d0938713774b3916cfeebdab
Author: njnu-seafish <[email protected]>
AuthorDate: Tue Jul 15 22:10:36 2025 +0800
[Doc-17327] Add helm section in development documentation in both Chinese
and English (#17335)
---
docs/docs/en/contribute/development-environment-setup.md | 14 ++++++++++++++
docs/docs/zh/contribute/development-environment-setup.md | 14 ++++++++++++++
2 files changed, 28 insertions(+)
diff --git a/docs/docs/en/contribute/development-environment-setup.md
b/docs/docs/en/contribute/development-environment-setup.md
index 4905e7d9de..86fbfd653a 100644
--- a/docs/docs/en/contribute/development-environment-setup.md
+++ b/docs/docs/en/contribute/development-environment-setup.md
@@ -54,6 +54,20 @@ pre-commit install
Now, every time you commit your code, `pre-commit` will automatically run
`Spotless` to check the code style and formatting.
+### Helm Template Guidelines
+
+After modifying files related to Helm templates, you can use the following
command to debug the Helm templates:
+
+```shell
+helm template ./deploy/kubernetes/dolphinscheduler --debug
+```
+
+Once the Helm templates are debugged and verified, use the following command
to automatically update the README.md file (manually updating may likely result
in incorrect formatting):
+
+```shell
+./mvnw validate -P helm-doc -pl :dolphinscheduler
+```
+
## Docker image build
DolphinScheduler will release new Docker images after it released, you could
find them in [Docker Hub](https://hub.docker.com/search?q=DolphinScheduler).
diff --git a/docs/docs/zh/contribute/development-environment-setup.md
b/docs/docs/zh/contribute/development-environment-setup.md
index d2e05f6772..da26faf221 100644
--- a/docs/docs/zh/contribute/development-environment-setup.md
+++ b/docs/docs/zh/contribute/development-environment-setup.md
@@ -51,6 +51,20 @@ pre-commit install
现在，每次您提交代码时，`pre-commit`都会自动运行`Spotless`来检查代码风格和格式。
+### Helm 模板规范
+
+当您修改了Helm模板相关的文件后， 可以使用如下命令来调试 Helm 模板：
+
+```shell
+helm template ./deploy/kubernetes/dolphinscheduler --debug
+```
+
+Helm模板调试通过之后，需要使用如下命令来自动更新README.md文件（手动更新很可能格式不符合要求）：
+
+```shell
+./mvnw validate -P helm-doc -pl :dolphinscheduler
+```
+
## Docker镜像构建
DolphinScheduler 每次发版都会同时发布 Docker 镜像，你可以在 [Docker
Hub](https://hub.docker.com/search?q=DolphinScheduler) 中找到这些镜像
