此文档中的信息可能已过时

此文档的更新日期比原文晚，因此其中的信息可能已过时。如果能阅读英文，请查看英文版本以获取最新信息： Generating Reference Documentation for Metrics

为指标生成参考文档

本页演示如何生成指标参考文档。

准备开始

指标的生成发生在 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 网站根环境变量
执行以下命令设置网站根目录：
```
export WEBSITE_ROOT=<path to website root>
```

要创建 PR，请按照提 PR 中的说明操作。