为 Kubernetes 文档做贡献

Kubernetes v1.12 版本的文档已不再维护。您现在看到的版本来自于一份静态的快照。如需查阅最新文档,请点击 最新版本。

Edit This Page

为 Kubernetes 联邦 API 生成参考文档

本节介绍如何为 Kubernetes 联邦 API 自动生成参考文档。

准备开始

运行 update-federation-api-docs.sh 脚本

如果你还没有 Kubernetes 联邦的源码,现在下载:

mkdir $GOPATH/src
cd $GOPATH/src
go get github.com/kubernetes/federation

确定本地 kubernetes/federation 仓库的主目录。 例如,如果按照前面的步骤获取联邦的源码,则主目录是 $GOPATH/src/github.com/kubernetes/federation。 下文将该目录称为 <fed-base>

运行文档生成脚本:

cd <fed-base>
hack/update-federation-api-reference-docs.sh

脚本运行 k8s.gcr.io/gen-swagger-docs 镜像来生成以下参考文档:

生成的文件不会被自动发布。你必须手工将它们复制到 kubernetes/website 仓库。

以下文件发布在 kubernetes.io/docs/reference

接下来

反馈