From 0241569e929e4a43b582858a75e234f14daffa35 Mon Sep 17 00:00:00 2001 From: ydFu Date: Wed, 7 Apr 2021 17:39:26 +0800 Subject: [PATCH] [zh] Sync contribute pages for kubernetes-api.md * Sync with english version in 'Fixed errors in instructions for generating ref docs (#27386)' Signed-off-by: ydFu --- .../generate-ref-docs/kubernetes-api.md | 61 +++++++++++-------- 1 file changed, 37 insertions(+), 24 deletions(-) diff --git a/content/zh/docs/contribute/generate-ref-docs/kubernetes-api.md b/content/zh/docs/contribute/generate-ref-docs/kubernetes-api.md index b0eb61a197..9059cdef1e 100644 --- a/content/zh/docs/contribute/generate-ref-docs/kubernetes-api.md +++ b/content/zh/docs/contribute/generate-ref-docs/kubernetes-api.md @@ -12,11 +12,11 @@ weight: 50 -本页面展示了如何为 Kubernetes API 更新自动生成的参考文档。 +本页面显示了如何更新 Kubernetes API 参考文档。 Kubernetes API 参考文档是从 [Kubernetes OpenAPI 规范](https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json) -构建的,而工具是从 -[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) 构建的。 +构建的, +且使用[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) 生成代码。 如果您在生成的文档中发现错误,则需要[在上游修复](/zh/docs/contribute/generate-ref-docs/contribute-upstream/)。 @@ -55,23 +55,30 @@ mkdir -p $HOME/ export GOPATH=$HOME/ ``` - + 获取以下仓库的本地克隆: ```shell -go get -u github.com/kubernetes-incubator/reference-docs +go get -u github.com/kubernetes-sigs/reference-docs + go get -u github.com/go-openapi/loads go get -u github.com/go-openapi/spec ``` - + 如果你还没有下载过 `kubernetes/website` 仓库,现在下载: ```shell git clone https://github.com//website $GOPATH/src/github.com//website ``` - + 克隆 kubernetes/kubernetes 仓库作为 k8s.io/kubernetes: ```shell @@ -90,8 +97,8 @@ The remaining steps refer to your base directory as ``. The remaining steps refer to your base directory as ``. * The base directory of your clone of the -[kubernetes-incubator/reference-docs](https://github.com/kubernetes-incubator/reference-docs) -repository is `$GOPATH/src/github.com/kubernetes-incubator/reference-docs.` +[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) +repository is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.` The remaining steps refer to your base directory as ``. --> * [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) 仓库克隆后的根目录为 @@ -99,7 +106,7 @@ The remaining steps refer to your base directory as ``. * [kubernetes/website](https://github.com/kubernetes/website) 仓库克隆后的根目录为 `$GOPATH/src/github.com//website`。后续步骤将此目录称为 ``。 * [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) - 仓库克隆后的基本目录为 `$GOPATH/src/github.com/kubernetes-sigs/reference-docs`。 + 仓库克隆后的基本目录为 `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.`。 后续步骤将此目录称为 ``。 * 设置 `K8S_ROOT` 为 ``. * 设置 `K8S_WEBROOT` 为 ``. * 设置 `K8S_RELEASE` 为要构建的文档的版本。 - 例如,如果您想为 Kubernetes 1.17 构建文档,请将 `K8S_RELEASE` 设置为 1.17。 + 例如,如果您想为 Kubernetes 1.17.0 构建文档,请将 `K8S_RELEASE` 设置为 1.17.0。 - + 例如: -``` +```shell export K8S_WEBROOT=$(GOPATH)/src/github.com//website export K8S_ROOT=$(GOPATH)/src/k8s.io/kubernetes -export K8S_RELEASE=1.17 +export K8S_RELEASE=1.17.0 ``` -在 '' 目录中,运行以下命令来构建: +在 `` 目录中,运行以下命令来构建: ```shell cd @@ -184,12 +193,14 @@ cd make copyapi ``` - + 验证是否已生成这两个文件: ```shell -[ -e "/gen-apidocs/generators/build/index.html" ] && echo "index.html built" || echo "no index.html" -[ -e "/gen-apidocs/generators/build/navData.js" ] && echo "navData.js built" || echo "no navData.js" +[ -e "/gen-apidocs/build/index.html" ] && echo "index.html built" || echo "no index.html" +[ -e "/gen-apidocs/build/navData.js" ] && echo "navData.js built" || echo "no navData.js" ``` + 输出类似于: ```