尧图网站建设 
Apache DolphinScheduler 文档贡献指南文档仓库构建、编写规范与 PR 提交实践【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler本篇指南聚焦 Apache DolphinScheduler 的文档贡献流程讲清楚官方文档维护在何处、如何在本地完整搭建并构建文档站点含 Node 版本管理、中文文档的编写排版规范以及如何规范地提交文档 Pull Request。读完后你可以独立完成从 fork 文档仓库到本地预览验证、再到提交 PR 的完整文档贡献闭环并理解本项目docs/目录下中英双语文档、站点配置与图片工具的组织方式。文档项目在哪主仓库与文档仓库的分工良好的文档对任何类型的软件都至关重要DolphinScheduler 欢迎一切能改进其文档的贡献。理解文档贡献的第一步是弄清文档内容的维护位置DolphinScheduler 项目的文档维护在独立的文档仓库dolphinscheduler-website中而不是主代码仓库本身。因此文档贡献者需要先 fork 该文档仓库再克隆到本地。当前主仓库中的docs/目录则承载了文档源文件与站点构建相关资源可作为理解文档组织结构的参照。从源码结构看该目录大致分为三部分docs/docs/en 与 docs/docs/zh英文与中文两套完整文档源文件目录结构一一对应about/、architecture/、contribute/、guide/等docs/configs文档站点的导航与站点配置docs/img文档图片资源及图片处理工具脚本 img_utils.py。这一双仓库 双语源文件的组织方式决定了后文构建流程与 PR 提交规则如只需推送*.md和*.js配置文件的存在意义文档内容、站点导航配置与静态资源是分文件、分职责维护的。获取文档项目按照官方文档说明见 document.md文档贡献的第一步是获取文档仓库先将文档项目 fork 到你自己的 GitHub 仓库再将 fork 后的项目克隆到本地计算机git clone https://github.com/your-github-user-name/dolphinscheduler-website文档构建指南从依赖安装到本地验证文档仓库采用基于 yarn 的前端工程结构官方给出的完整构建流程共 6 步可复制执行安装依赖在文档仓库根目录运行yarn收集资源运行export PROTOCOL_MODEssh告诉 Git 通过 SSH 协议而非 HTTPS 协议克隆相关资源运行./scripts/prepare_docs.sh准备所有相关资源该脚本负责拉取/同步文档内容文档仓库中附有对其工作机制的说明文档HOW_PREPARE_WORK.md格式化与数据准备在根目录运行yarn generate对数据做格式化并准备站点数据启动本地开发服务器运行yarn dev随后可在http://localhost:3000查看网站效果构建产物运行yarn build构建源码完成后会生成名为build的目录等待执行结束后进入该目录本地验证你的改动Python 2 环境python -m SimpleHTTPServer 8000Python 3 环境python3 -m http.server 8000也就是说日常开发用yarn dev端口 3000热更新预览正式验证则走yarn build后用 Python 内置 HTTP 服务器端口 8000静态访问build目录。使用 nvm 管理 Node 版本文档构建对 Node 版本有明确要求官方推荐 Node 18。如果本机安装了更高版本的 Node可以使用nvm让不同版本的 Node 共存参考 nvm 官方说明安装 nvm运行nvm install v18.12.1安装 Node v18运行nvm use v18.12.1将当前工作环境切换到 Node v18。完成上述配置后即可按上面的构建指令运行和构建网站。站点配置文档目录在站点中如何呈现结合主仓库中保留的站点配置可以加深对文档站点结构的理解docs/configs/site.js全局站点配置定义了en-us与zh-cn两套语言的页头导航、版本切换菜单等。从源码结构看文档版本菜单同时提供latest配置中为 3.4.2以及 3.1.9、2.0.7 等历史版本入口例如latest版本的文档入口为/en-us/docs/latest/user_doc/about/introduction.html这解释了文档 URL 中latest与具体版本号并存的原因docs/configs/docsdev.js开发环境下的侧边栏sidemenu配置按About、Quick Start、Introduction to Functions等章节组织各文档页面的标题与链接共约 1400 行与docs/docs/en、docs/docs/zh下的 Markdown 文件一一对应。修改文档目录结构时这类导航配置文件往往需要同步更新——这也正是后文 PR 提交规则中要求推送docs.js or site.js一类配置文件的背景docs/img_utils.py文档图片处理工具脚本基于 argparse 提供命令行接口用于处理docs/img下的文档配图。文档编写规范官方对文档尤其是中文文档的排版有两条明确的规范要求详见 中文文档须知中英文/数字混排的空格规则汉字与英文、数字之间需要空格中文标点符号与英文、数字之间不需要空格目的是增强中英文混排的美观性和可读性。称呼规则一般建议使用你必要时可以使用您比如有 warning 提示的场景。这两条规则是文档评审时的常见检查点提交文档 PR 前建议自查排版是否一致。如何提交文档 Pull Request官方对文档 PR 的提交方式有明确约束核心原则是最小化提交范围不要使用git add .提交所有变更包括prepare_docs.sh等脚本自动生成的中间产物只推送实际修改的文件典型的两类*.md文档内容本身blog.js or docs.js or site.js站点导航/目录配置当文档目录结构变化时需要同步修改向master分支提交 Pull Request。对照主仓库的docs/目录结构可以看到这一规则与工程组织是吻合的文档源文件docs/docs/en、docs/docs/zh下的*.md、导航配置docs/configs/下的*.js与图片资源docs/img相互独立贡献者只需精确提交自己改动的部分避免把自动生成的文件混入 PR。相关文档入口文档贡献者还可以参考以下仓库内的相关贡献文档与本篇形成完整上下文contribute/join 目录收录了贡献入口相关的全部指南包括 contribute.md、pull-request.md、issue.md、review.md 等api-standard.md、unit-test.md、e2e-test.md当你需要从文档扩展到代码层面的贡献API 规范、单元测试、端到端测试时查阅官方文档写作规范参考了 Apache Flink 的文档翻译规范Flink Translation Specifications可作为文档风格与术语一致性的延伸阅读。小结DolphinScheduler 的文档贡献链路是fork 并克隆文档仓库 →yarn安装依赖 →PROTOCOL_MODEsshprepare_docs.sh收集资源 →yarn generate准备数据 →yarn dev本地预览3000 端口→yarn build后用 Python 静态服务验证8000 端口→ 按中文混排空格 你/您规范打磨文案 → 只推送*.md与必要的*.js配置文件 → 向master分支提交 PR。结合主仓库docs/下中英双语源文件与docs/configs/站点配置的分工这条流程的每个环节都有对应的工程落点可循。【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Apache DolphinScheduler 文档贡献指南：文档仓库构建、编写规范与 PR 提交实践
Apache DolphinScheduler 文档贡献指南文档仓库构建、编写规范与 PR 提交实践【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler本篇指南聚焦 Apache DolphinScheduler 的文档贡献流程讲清楚官方文档维护在何处、如何在本地完整搭建并构建文档站点含 Node 版本管理、中文文档的编写排版规范以及如何规范地提交文档 Pull Request。读完后你可以独立完成从 fork 文档仓库到本地预览验证、再到提交 PR 的完整文档贡献闭环并理解本项目docs/目录下中英双语文档、站点配置与图片工具的组织方式。文档项目在哪主仓库与文档仓库的分工良好的文档对任何类型的软件都至关重要DolphinScheduler 欢迎一切能改进其文档的贡献。理解文档贡献的第一步是弄清文档内容的维护位置DolphinScheduler 项目的文档维护在独立的文档仓库dolphinscheduler-website中而不是主代码仓库本身。因此文档贡献者需要先 fork 该文档仓库再克隆到本地。当前主仓库中的docs/目录则承载了文档源文件与站点构建相关资源可作为理解文档组织结构的参照。从源码结构看该目录大致分为三部分docs/docs/en 与 docs/docs/zh英文与中文两套完整文档源文件目录结构一一对应about/、architecture/、contribute/、guide/等docs/configs文档站点的导航与站点配置docs/img文档图片资源及图片处理工具脚本 img_utils.py。这一双仓库 双语源文件的组织方式决定了后文构建流程与 PR 提交规则如只需推送*.md和*.js配置文件的存在意义文档内容、站点导航配置与静态资源是分文件、分职责维护的。获取文档项目按照官方文档说明见 document.md文档贡献的第一步是获取文档仓库先将文档项目 fork 到你自己的 GitHub 仓库再将 fork 后的项目克隆到本地计算机git clone https://github.com/your-github-user-name/dolphinscheduler-website文档构建指南从依赖安装到本地验证文档仓库采用基于 yarn 的前端工程结构官方给出的完整构建流程共 6 步可复制执行安装依赖在文档仓库根目录运行yarn收集资源运行export PROTOCOL_MODEssh告诉 Git 通过 SSH 协议而非 HTTPS 协议克隆相关资源运行./scripts/prepare_docs.sh准备所有相关资源该脚本负责拉取/同步文档内容文档仓库中附有对其工作机制的说明文档HOW_PREPARE_WORK.md格式化与数据准备在根目录运行yarn generate对数据做格式化并准备站点数据启动本地开发服务器运行yarn dev随后可在http://localhost:3000查看网站效果构建产物运行yarn build构建源码完成后会生成名为build的目录等待执行结束后进入该目录本地验证你的改动Python 2 环境python -m SimpleHTTPServer 8000Python 3 环境python3 -m http.server 8000也就是说日常开发用yarn dev端口 3000热更新预览正式验证则走yarn build后用 Python 内置 HTTP 服务器端口 8000静态访问build目录。使用 nvm 管理 Node 版本文档构建对 Node 版本有明确要求官方推荐 Node 18。如果本机安装了更高版本的 Node可以使用nvm让不同版本的 Node 共存参考 nvm 官方说明安装 nvm运行nvm install v18.12.1安装 Node v18运行nvm use v18.12.1将当前工作环境切换到 Node v18。完成上述配置后即可按上面的构建指令运行和构建网站。站点配置文档目录在站点中如何呈现结合主仓库中保留的站点配置可以加深对文档站点结构的理解docs/configs/site.js全局站点配置定义了en-us与zh-cn两套语言的页头导航、版本切换菜单等。从源码结构看文档版本菜单同时提供latest配置中为 3.4.2以及 3.1.9、2.0.7 等历史版本入口例如latest版本的文档入口为/en-us/docs/latest/user_doc/about/introduction.html这解释了文档 URL 中latest与具体版本号并存的原因docs/configs/docsdev.js开发环境下的侧边栏sidemenu配置按About、Quick Start、Introduction to Functions等章节组织各文档页面的标题与链接共约 1400 行与docs/docs/en、docs/docs/zh下的 Markdown 文件一一对应。修改文档目录结构时这类导航配置文件往往需要同步更新——这也正是后文 PR 提交规则中要求推送docs.js or site.js一类配置文件的背景docs/img_utils.py文档图片处理工具脚本基于 argparse 提供命令行接口用于处理docs/img下的文档配图。文档编写规范官方对文档尤其是中文文档的排版有两条明确的规范要求详见 中文文档须知中英文/数字混排的空格规则汉字与英文、数字之间需要空格中文标点符号与英文、数字之间不需要空格目的是增强中英文混排的美观性和可读性。称呼规则一般建议使用你必要时可以使用您比如有 warning 提示的场景。这两条规则是文档评审时的常见检查点提交文档 PR 前建议自查排版是否一致。如何提交文档 Pull Request官方对文档 PR 的提交方式有明确约束核心原则是最小化提交范围不要使用git add .提交所有变更包括prepare_docs.sh等脚本自动生成的中间产物只推送实际修改的文件典型的两类*.md文档内容本身blog.js or docs.js or site.js站点导航/目录配置当文档目录结构变化时需要同步修改向master分支提交 Pull Request。对照主仓库的docs/目录结构可以看到这一规则与工程组织是吻合的文档源文件docs/docs/en、docs/docs/zh下的*.md、导航配置docs/configs/下的*.js与图片资源docs/img相互独立贡献者只需精确提交自己改动的部分避免把自动生成的文件混入 PR。相关文档入口文档贡献者还可以参考以下仓库内的相关贡献文档与本篇形成完整上下文contribute/join 目录收录了贡献入口相关的全部指南包括 contribute.md、pull-request.md、issue.md、review.md 等api-standard.md、unit-test.md、e2e-test.md当你需要从文档扩展到代码层面的贡献API 规范、单元测试、端到端测试时查阅官方文档写作规范参考了 Apache Flink 的文档翻译规范Flink Translation Specifications可作为文档风格与术语一致性的延伸阅读。小结DolphinScheduler 的文档贡献链路是fork 并克隆文档仓库 →yarn安装依赖 →PROTOCOL_MODEsshprepare_docs.sh收集资源 →yarn generate准备数据 →yarn dev本地预览3000 端口→yarn build后用 Python 静态服务验证8000 端口→ 按中文混排空格 你/您规范打磨文案 → 只推送*.md与必要的*.js配置文件 → 向master分支提交 PR。结合主仓库docs/下中英双语源文件与docs/configs/站点配置的分工这条流程的每个环节都有对应的工程落点可循。【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考