文档协作流程
文档系统
公司文档仓库 https://sh-code.mthreads.com/devops/document-site 文档仓库联系人 林枭 开发分支：dev 发布分支：master 预览 系统 https://document-dev.devops.mthreads.com/ 正式系统 https://document.devops.mthreads.com/ （正式上线后，域名会重新解析成 docs.mthreads.com，目前仅限公司内网访问） 系统软件 https://docusaurus.io/zh-CN/docs
文档协作工作流
- 在工作文件夹启动 terminal 执行
git pull https://sh-code.mthreads.com/devops/document-site.git从远程仓库拉取代码，terminal 中执行
cd document-site
git checkout dev
- Write：确定修改文件，在本地运行项目并编辑，实时查看修改效果。文档 PIC 负责编辑文档,在开发环境预览没问题后，使用
git push命令提交到 dev 分支，系统将自动发布到预览系统（发布生效时间 15 分钟左右） - Review：各 product manager 负责组织 engineer manager, product manager, legal, mkt 在预览系统进行 review
- Sign off：review 通过后在文档中心-tracker“审核”列进行 Sign off，文档 PIC 提交 dev 分支 merge 申请
- Publish： engineer manager 负责通过 merge 申请，发布到 master 分支，并在正式环境确认内容与评审内容内容一致（发布生效时间 15 分钟左右）
- Email to all：单产品所有文档完成发布后，由 engineer manager/product manager 发送 email 公示
提示
尽量避免直接在代码仓库中修改文档，避免影响其他开发者，先在自己环境检查没有语法错误后再提交到公司文档仓库 dev 分支
