参考文档快速入门

本页面展示如何使用 update-imported-docs.py 脚本生成 Kubernetes 参考文档。该脚本自动执行构建设置并为发布生成参考文档。

在您开始之前

要求

您需要一台运行 Linux 或 macOS 的机器。
您需要安装以下工具
- Python v3.7.x+
- Git
- Golang 版本 1.13+
- Pip 用于安装 PyYAML
- PyYAML v5.1.2
- make
- gcc 编译器/链接器
- Docker (仅在 kubectl 命令参考中需要)
您的 PATH 环境变量必须包含必要的构建工具，例如 Go 二进制文件和 python。
您需要了解如何向 GitHub 存储库创建拉取请求。这涉及创建您自己的存储库分支。有关更多信息，请参阅从本地克隆工作。

获取文档存储库

确保您的 website 分支与 GitHub 上的 kubernetes/website 远程分支 (main 分支) 保持同步，并克隆您的 website 分支。

mkdir github.com
cd github.com
git clone git@github.com:<your_github_username>/website.git

确定克隆的基目录。例如，如果您遵循前面的步骤获取存储库，则您的基目录是 github.com/website。以下步骤将您的基目录称为 <web-base>。

注意

如果您想更改组件工具和 API 参考的内容，请参阅上游贡献指南。

update-imported-docs 概述

update-imported-docs.py 脚本位于 <web-base>/update-imported-docs/ 目录中。

该脚本构建以下参考

组件和工具参考页面
kubectl 命令参考
Kubernetes API 参考

update-imported-docs.py 脚本从 Kubernetes 源代码生成 Kubernetes 参考文档。该脚本在您机器上的 /tmp 下创建一个临时目录，并将所需的存储库：kubernetes/kubernetes 和 kubernetes-sigs/reference-docs 克隆到该目录中。该脚本将您的 GOPATH 设置为该临时目录。设置了三个额外的环境变量

K8S_RELEASE
K8S_ROOT
K8S_WEBROOT

该脚本需要两个参数才能成功运行

一个 YAML 配置文件 (reference.yml)
一个发布版本，例如：1.17

配置文件包含一个 generate-command 字段。generate-command 字段定义了一系列来自 kubernetes-sigs/reference-docs/Makefile 的构建指令。K8S_RELEASE 变量确定发布的版本。

update-imported-docs.py 脚本执行以下步骤

克隆配置文件中指定的相关存储库。为了生成参考文档，默认情况下克隆的存储库是 kubernetes-sigs/reference-docs。
在克隆的存储库下运行命令以准备文档生成器，然后生成 HTML 和 Markdown 文件。
将生成的 HTML 和 Markdown 文件复制到 <web-base> 存储库的本地克隆中，位置由配置文件中指定的 location 指定。
更新 kubectl 命令链接，从 kubectl.md 指向 kubectl 命令参考中的部分。

当生成的文件在您的 <web-base> 存储库的本地克隆中时，您可以在拉取请求中将它们提交到 <web-base>。

配置文件格式

每个配置文件可以包含多个将一起导入的存储库。在必要时，您可以通过手动编辑配置文件来自定义它。您可以创建新的配置文件以导入其他组文档。以下是一个 YAML 配置文件的示例

repos:
- name: community
  remote: https://github.com/kubernetes/community.git
  branch: master
  files:
  - src: contributors/devel/README.md
    dst: docs/imported/community/devel.md
  - src: contributors/guide/README.md
    dst: docs/imported/community/guide.md

由工具导入的单页 Markdown 文档必须遵守文档风格指南。

自定义 reference.yml

打开 <web-base>/update-imported-docs/reference.yml 进行编辑。除非您了解如何使用该命令构建参考，否则不要更改 generate-command 字段的内容。您应该不需要更新 reference.yml。有时，上游源代码的更改可能需要更改配置文件（例如：golang 版本依赖项和第三方库更改）。如果您遇到构建问题，请联系 #sig-docs Kubernetes Slack 频道上的 SIG-Docs 团队。

注意

generate-command 是一个可选条目，可用于运行给定命令或简短脚本以从存储库中生成文档。

在 reference.yml 中，files 包含 src 和 dst 字段的列表。src 字段包含克隆的 kubernetes-sigs/reference-docs 构建目录中生成的 Markdown 文件的位置，而 dst 字段指定在克隆的 kubernetes/website 存储库中将此文件复制到哪里。例如

repos:
- name: reference-docs
  remote: https://github.com/kubernetes-sigs/reference-docs.git
  files:
  - src: gen-compdocs/build/kube-apiserver.md
    dst: content/en/docs/reference/command-line-tools-reference/kube-apiserver.md
  ...

请注意，当需要从同一个源目录复制多个文件到同一个目标目录时，可以在提供给 src 的值中使用通配符。您必须提供目录名称作为 dst 的值。例如

  files:
  - src: gen-compdocs/build/kubeadm*.md
    dst: content/en/docs/reference/setup-tools/kubeadm/generated/

运行 update-imported-docs 工具

您可以按如下方式运行 update-imported-docs.py 工具

cd <web-base>/update-imported-docs
./update-imported-docs.py <configuration-file.yml> <release-version>

例如

./update-imported-docs.py reference.yml 1.17

修复链接

release.yml 配置文件包含修复相对链接的指令。要修复导入文件中的相对链接，请将 gen-absolute-links 属性设置为 true。您可以在 release.yml 中找到一个示例。

在 kubernetes/website 中添加和提交更改

列出已生成并复制到 <web-base> 的文件

cd <web-base>
git status

输出显示了新文件和修改后的文件。生成的输出根据对上游源代码所做的更改而有所不同。

生成的组件工具文件

content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md
content/en/docs/reference/command-line-tools-reference/kube-apiserver.md
content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md
content/en/docs/reference/command-line-tools-reference/kube-proxy.md
content/en/docs/reference/command-line-tools-reference/kube-scheduler.md
content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md
content/en/docs/reference/kubectl/kubectl.md

生成的 kubectl 命令参考文件

static/docs/reference/generated/kubectl/kubectl-commands.html
static/docs/reference/generated/kubectl/navData.js
static/docs/reference/generated/kubectl/scroll.js
static/docs/reference/generated/kubectl/stylesheet.css
static/docs/reference/generated/kubectl/tabvisibility.js
static/docs/reference/generated/kubectl/node_modules/bootstrap/dist/css/bootstrap.min.css
static/docs/reference/generated/kubectl/node_modules/highlight.js/styles/default.css
static/docs/reference/generated/kubectl/node_modules/jquery.scrollto/jquery.scrollTo.min.js
static/docs/reference/generated/kubectl/node_modules/jquery/dist/jquery.min.js
static/docs/reference/generated/kubectl/css/font-awesome.min.css

生成的 Kubernetes API 参考目录和文件

static/docs/reference/generated/kubernetes-api/v1.31/index.html
static/docs/reference/generated/kubernetes-api/v1.31/js/navData.js
static/docs/reference/generated/kubernetes-api/v1.31/js/scroll.js
static/docs/reference/generated/kubernetes-api/v1.31/js/query.scrollTo.min.js
static/docs/reference/generated/kubernetes-api/v1.31/css/font-awesome.min.css
static/docs/reference/generated/kubernetes-api/v1.31/css/bootstrap.min.css
static/docs/reference/generated/kubernetes-api/v1.31/css/stylesheet.css
static/docs/reference/generated/kubernetes-api/v1.31/fonts/FontAwesome.otf
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.eot
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.svg
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.ttf
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.woff
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.woff2

运行 git add 和 git commit 以提交文件。

创建拉取请求

向 kubernetes/website 存储库创建拉取请求。监控您的拉取请求，并在需要时回复评论。继续监控您的拉取请求，直到它被合并。

您的拉取请求合并后几分钟，您更新的参考主题将显示在已发布的文档中。

下一步

要通过手动设置所需的构建存储库并运行构建目标来生成单独的参考文档，请参阅以下指南

上次修改时间：2022 年 10 月 27 日下午 3:04 PST：调整参考文档部分索引 (3c33ffc914)