文档编写

该文档已从 vuepress 迁移到 docusaurus

docusaurus 中文文档

  1. 下载alita-devops项目
  2. vscode 导入项目，执行命令
# 初始化项目
yarn install
# 启动项目
yarn start
# 打包为静态页面
yarn build
  1. 在docs下编写 markdown 文档
  2. 配置侧边栏（编辑sidebars.js文件）
  3. 打包发布

项目结构

  • 所有的文档存放在docs目录下
  • 所有的配置存放在docusaurus.config.js文件中
  • 打包后的目录为build
- docs # 各种文档资料
| - biz # 业务文档
| - dev # 研发资料
| - work # 工作以及运维文档
- sidebars.js # 文档的侧边栏目录
- docusaurus.config.js # 项目的配置
- package.json # workpack配置，无需关注

文档发布流程

  1. 打包
    • 打包 yarn build
    • 压缩包 tar -czvf build.tar.gz build
  2. 发布
    • 连接测试服务器
    • cd /usr/share/nginx/html
    • 把压缩包放至该目录，并把当前目录 work 删除
    • 解压 tar -xzvf build.tar.gz build
Edit this page