文档发布
每个小版本都有相应的文档版本。本指南是对整个发布过程的介绍。
保持多语言文档同步(手动)
有时贡献者不会更新所有语言文档的内容。在发布之前，请确保多语种文档同步。这将通过一个 issue 来跟踪。issue 应遵循以下格式:
This issue is to track documents which needs to sync zh for release 1.x:
* #268
更新参考文档(手动)
在发布之前，我们需要更新网站中的参考文档，包括 CLI 引用和组件引用。整个过程由脚本自动完成。按照以下步骤更新参考文档。
- 将
karmada-io/karmada和karmada-io/website克隆到本地环境。建议将这两个项目放在同一个文件夹中。
$ git clone https://github.com/karmada-io/karmada.git
$ git clone https://github.com/karmada-io/website.git
$ tree -L 1
#.
#├── karmada
#├── website
- 在 karmada 根目录下执行 generate 命令。
cd karmada/
go run ./hack/tools/genkarmadactldocs/gen_karmadactl_docs.go ../website/docs/reference/karmadactl/karmadactl-commands/
go run ./hack/tools/genkarmadactldocs/gen_karmadactl_docs.go ../website/i18n/zh/docusaurus-plugin-content-docs/current/reference/karmadactl/karmadactl-commands/
- 生成每个组件的参考文档。
cd karmada/
go build ./hack/tools/gencomponentdocs/.
components=(karmada-controller-manager karmada-scheduler karmada-agent karmada-aggregated-apiserver karmada-descheduler karmada-search karmada-scheduler-estimator karmada-webhook karmada-metrics-adapter)
for component in ${components};do
./gencomponentdocs ../website/docs/reference/components/ $component
./gencomponentdocs ../website/i18n/zh/docusaurus-plugin-content-docs/current/reference/components/ $component
done
建立 release-1.x(手动)
- 更新 versions.json
$ cd website/
$ vim versions.json
[
v1.5 # add a new version tag
v1.4
v1.3
]
- 更新 vesioned_docs
mkdir versioned_docs/version-v1.5
cp docs/* versioned_docs/version-v1.5 -r
- 更新 versioned_sidebars
cp versioned_sidebars/version-v1.4-sidebars.json versioned_sidebars/version-v1.5-sidebars.json
sed -i'' -e "s/version-v1.4/version-v1.5/g" versioned_sidebars/version-v1.5-sidebars.json
然后，对照 sidebars.js 更新 version-v1.5-sidebars.json
- 更新中文的 versioned_docs
mkdir i18n/zh/docusaurus-plugin-content-docs/version-v1.5
cp i18n/zh/docusaurus-plugin-content-docs/current/* i18n/zh/docusaurus-plugin-content-docs/version-v1.5 -r
- 更新中文的 versioned_sidebars
cp i18n/zh/docusaurus-plugin-content-docs/current.json i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json
sed -i'' -e "s/Next/v1.5/g" i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json