DolphinScheduler 项目的文档维护在独立的 中。
首先你需要先将文档项目 fork 到自己的 github 仓库中,然后将 fork 的文档克隆到本地计算机中。
文档环境
DolphinScheduler 网站由 提供支持。
如果你的 docsite 版本低于 “1.3.3”,请升级到 “1.3.3”。
请确保你的 node 版本是 8.x,docsite 尚不支持高于 8.x 的版本。
在根目录下运行 “docsite start” 启动本地服务器,其将允许在 http://127.0.0.1:8080。
运行 “docsite build” 可以生成文档网站源代码。
在本地验证你的更改:,当 python 版本为 3 时,请使用:。
如果本地安装了更高版本的 node,可以考虑使用 “nvm” 来允许不同版本的 node 在你的计算机上运行。
参考安装 nvm
运行 “nvm install v8.16.0” 安装 node v8
运行
然后你就可以在本地环境运行和建立网站了。
文档规范
汉字与英文、数字之间需空格,中文标点符号与英文、数字之间不需空格,以增强中英文混排的美观性和可读性。
建议在一般情况下使用 “你” 即可。当然必要的时候可以使用 “您” 来称呼,比如有 warning 提示的时候。
不要使用 “git add.” 提交所有更改。
只需推送更改的文件,例如:
- 向 master 分支提交 Pull Request。