Information in this document may be out of date
This document has an older update date than the original, so the information it contains may be out of date. If you're able to read English, see the English version for the most up-to-date information: Generating Reference Documentation for Metrics
为指标生成参考文档
本页演示如何生成指标参考文档。
准备开始
需求
-
你需要一台 Linux 或 macOS 机器。
-
你需要安装以下工具：
-
你的
PATH环境变量必须包含所需要的构建工具，例如Go程序和python。 -
你需要知道如何为一个 GitHub 仓库创建拉取请求（PR）。 这牵涉到创建仓库的派生（fork）副本。 有关信息可进一步查看基于本地副本开展工作。
克隆 Kubernetes 仓库
指标的生成发生在 Kubernetes 仓库中。 要克隆此仓库，请将目录更改为你要克隆到的目标位置。
然后，执行以下命令：
git clone https://www.github.com/kubernetes/kubernetes
这将在当前工作目录中创建一个 kubernetes 文件夹。
生成指标
在克隆的 Kubernetes 仓库中，找到 test/instrumentation/documentation 目录。
指标文档将在此目录中生成。
每次发布都会添加新的指标。你在运行指标文档生成脚本之后， 将指标文档复制到 Kubernetes 网站并发布更新的指标文档。
要生成最新的指标，请确保你位于已克隆的 Kubernetes 仓库的根目录中。 然后，执行以下命令：
./test/instrumentation/update-documentation.sh
要检查变更，执行以下命令：
git status
输出类似于：
./test/instrumentation/documentation/documentation.md
./test/instrumentation/documentation/documentation-list.yaml
将生成的指标文档文件复制到 Kubernetes 网站仓库
-
设置 Kubernetes 网站根环境变量
执行以下命令设置网站根目录：
export WEBSITE_ROOT=<path to website root>
-
将生成的指标文件复制到 Kubernetes 网站仓库。
cp ./test/instrumentation/documentation/documentation.md "${WEBSITE_ROOT}/content/en/docs/reference/instrumentation/metrics.md"说明：如果出现错误，请检查你是否有权限复制文件。 你可以使用
chown命令将文件所有权更改回你自己的用户。
创建 PR
要创建 PR，请按照提 PR 中的说明操作。