2.4 KiB
文档须知
良好的使用文档对任何类型的软件都是至关重要的。欢迎任何可以改进 DolphinScheduler 文档的贡献。
获取文档项目
DolphinScheduler 项目的文档维护在独立的 git 仓库中。
首先你需要先将文档项目 fork 到自己的 github 仓库中,然后将 fork 的文档克隆到本地计算机中。
git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
文档环境
DolphinScheduler 网站由 docsite 提供支持。
请确保你的 node 版本是 10+,docsite 尚不支持高于 10.x 的版本。
文档构建指南
-
在根目录中运行
npm install
以安装依赖项。 -
运行命令收集资源:2.1.运行
export PROTOCOL_MODE=ssh
告诉Git克隆资源,通过SSH协议而不是HTTPS协议。 2.2.运行./scripts/prepare_docs.sh
准备所有相关资源,关更多信息,您可以查看how prepare script work。 -
在根目录下运行
npm run start
启动本地服务器,其将允许在 http://localhost:8080。 -
运行
npm run build
可以生成文档网站源代码。 -
在本地验证你的更改:
python -m SimpleHTTPServer 8000
,当 python 版本为 3 时,请使用:python3 -m http.server 8000
。
如果本地安装了更高版本的 node,可以考虑使用 nvm
来允许不同版本的 node
在你的计算机上运行。
-
参考说明安装 nvm
-
运行
nvm install v10.23.1
安装 node v10 -
运行
nvm use v10.23.1
将当前工作环境切换到 node v10
然后你就可以在本地环境运行和建立网站了。
文档规范
-
汉字与英文、数字之间需空格,中文标点符号与英文、数字之间不需空格,以增强中英文混排的美观性和可读性。
-
建议在一般情况下使用 “你” 即可。当然必要的时候可以使用 “您” 来称呼,比如有 warning 提示的时候。
怎样提交文档 Pull Request
-
不要使用 “git add.” 提交所有更改。
-
只需推送更改的文件,例如:
*.md
blog.js or docs.js or site.js
- 向 master 分支提交 Pull Request。