Skip to content

Commit ff3a9c0

Browse files
authored
[Doc-17327] Add helm section in development documentation in both Chinese and English (#17335)
1 parent f380189 commit ff3a9c0

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

docs/docs/en/contribute/development-environment-setup.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,20 @@ pre-commit install
5454

5555
Now, every time you commit your code, `pre-commit` will automatically run `Spotless` to check the code style and formatting.
5656

57+
### Helm Template Guidelines
58+
59+
After modifying files related to Helm templates, you can use the following command to debug the Helm templates:
60+
61+
```shell
62+
helm template ./deploy/kubernetes/dolphinscheduler --debug
63+
```
64+
65+
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):
66+
67+
```shell
68+
./mvnw validate -P helm-doc -pl :dolphinscheduler
69+
```
70+
5771
## Docker image build
5872

5973
DolphinScheduler will release new Docker images after it released, you could find them in [Docker Hub](https://hub.docker.com/search?q=DolphinScheduler).

docs/docs/zh/contribute/development-environment-setup.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,20 @@ pre-commit install
5151

5252
现在,每次您提交代码时,`pre-commit`都会自动运行`Spotless`来检查代码风格和格式。
5353

54+
### Helm 模板规范
55+
56+
当您修改了Helm模板相关的文件后, 可以使用如下命令来调试 Helm 模板:
57+
58+
```shell
59+
helm template ./deploy/kubernetes/dolphinscheduler --debug
60+
```
61+
62+
Helm模板调试通过之后,需要使用如下命令来自动更新README.md文件(手动更新很可能格式不符合要求):
63+
64+
```shell
65+
./mvnw validate -P helm-doc -pl :dolphinscheduler
66+
```
67+
5468
## Docker镜像构建
5569

5670
DolphinScheduler 每次发版都会同时发布 Docker 镜像,你可以在 [Docker Hub](https://hub.docker.com/search?q=DolphinScheduler) 中找到这些镜像

0 commit comments

Comments
 (0)