文档发布

每个小版本都有相应的文档版本。本指南是对整个发布过程的介绍。

保持多语言文档同步(手动)

有时贡献者不会更新所有语言文档的内容。在发布之前，请确保多语种文档同步。这将通过一个 issue 来跟踪。issue 应遵循以下格式:

  1. This issue is to track documents which needs to sync zh for release 1.x:
  2. * #268

更新参考文档(手动)

在发布之前，我们需要更新网站中的参考文档，包括 CLI 引用和组件引用。整个过程由脚本自动完成。按照以下步骤更新参考文档。

  1. 将 karmada-io/karmada 和 karmada-io/website 克隆到本地环境。建议将这两个项目放在同一个文件夹中。
  1. $ git clone https://github.com/karmada-io/karmada.git
  2. $ git clone https://github.com/karmada-io/website.git
  5. $ tree -L 1
  6. #.
  7. #├── karmada
  8. #├── website
  1. 在 karmada 根目录下执行 generate 命令。
  1. cd karmada/
  2. go run ./hack/tools/genkarmadactldocs/gen_karmadactl_docs.go ../website/docs/reference/karmadactl/karmadactl-commands/
  3. go run ./hack/tools/genkarmadactldocs/gen_karmadactl_docs.go ../website/i18n/zh/docusaurus-plugin-content-docs/current/reference/karmadactl/karmadactl-commands/
  1. 逐一生成每个组件的参考文档。这里我们以 karmada-apiserver 为例
  1. cd karmada/
  2. go build ./hack/tools/gencomponentdocs/.
  3. ./gencomponentdocs ../website/docs/reference/components/ karmada-apiserver
  4. ./gencomponentdocs ../website/i18n/zh/docusaurus-plugin-content-docs/current/reference/components/ karmada-apiserver

建立 release-1.x(手动)

  1. 更新 versions.json
  1. cd website/
  2. vim versions.json
  4. [
  5.   v1.5  # add a new version tag
  6.   v1.4
  7.   v1.3
  8. ]
  1. 更新 vesioned_docs
  1. mkdir versioned_docs/version-v1.5
  2. cp docs/* versioned_docs/version-v1.5 -r
  1. 更新 versioned_sidebars
  1. cp versioned_sidebars/version-v1.4-sidebars.json versioned_sidebars/version-v1.5-sidebars.json
  2. sed -i'' -e "s/version-v1.4/version-v1.5/g" versioned_sidebars/version-v1.5-sidebars.json
  3. # update version-v1.5-sidebars.json based on sidebars.js
  1. 更新中文的 versioned_docs
  1. mkdir i18n/zh/docusaurus-plugin-content-docs/version-v1.5
  2. cp i18n/zh/docusaurus-plugin-content-docs/current/*  i18n/zh/docusaurus-plugin-content-docs/version-v1.5 -r
  1. 更新中文的 versioned_sidebars
  1. cp i18n/zh/docusaurus-plugin-content-docs/current.json i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json
  2. sed -i'' -e "s/Next/v1.5/g" i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json

检查变更的文件和主仓库的差异部分，并创建 Pull Request(手动)