# Генерація довідкової документації для метрик

LLMS index: [llms.txt](/llms.txt)

---

<!-- overview -->

Ця сторінка демонструє, як згенерувати довідкову документацію для метрик.

## Перш ніж ви розпочнете


	<h3 id="prerequisites">Вимоги:<a class="td-heading-self-link" href="#prerequisites" aria-label="Heading self-link"></a></h3>
<ul>
<li>
<p>Вам потрібна машина, що працює під управлінням Linux або macOS. У Windows використовуйте <a href="https://learn.microsoft.com/en-us/windows/wsl/install">Підсистема Windows для Linux (WSL)</a>, оскільки інструменти збірки покладаються на <code>make</code> та Bash-скрипти.</p>
</li>
<li>
<p>Вам потрібно встановити ці інструменти:</p>
<ul>
<li><a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git</a></li>
<li><a href="https://go.dev/dl/">Go</a>, будь-який нещодавній реліз (Go автоматично завантажує точну версію інструментарію, необхідну генератору)</li>
<li><a href="https://www.gnu.org/software/make/">make</a></li>
<li><a href="https://gcc.gnu.org/">gcc компілятор/лінкер</a></li>
<li><a href="https://docs.docker.com/engine/installation/">Docker</a> (Потрібен тільки для локального перегляду вебсайту за допомогою <code>make container-serve</code>)</li>
</ul>
</li>
<li>
<p>Вам потрібно знати, як створити pull request до репозиторію на GitHub. Це включає створення власного форку репозиторію. Для отримання додаткової інформації дивіться <a href="/uk/docs/contribute/new-content/open-a-pr/#fork-the-repo">Робота з локальним клоном</a>.</p>
</li>
</ul>


<!-- steps -->

## Клонування репозиторію Kubernetes {#clone-the-kubernetes-repository}

Генерація документації для метрик відбувається в репозиторії Kubernetes. Щоб клонувати репозиторій, перейдіть до теки, де ви хочете, щоб знаходилася клонована копія.

Потім виконайте наступну команду:

```shell
git clone https://www.github.com/kubernetes/kubernetes
```

Це створить теку `kubernetes` у вашій поточній робочій теці.

## Генерація документації для метрик {#generate-the-metrics}

У клонованому репозиторії Kubernetes знайдіть теку `test/instrumentation/documentation`. Документація для метрик генерується в цій теці.

З кожним релізом додаються нові метрики. Після того, як ви запустите скрипт генерації документації для метрик, скопіюйте документацію для метрик на вебсайт Kubernetes і опублікуйте оновлену документацію для метрик.

Щоб згенерувати останні метрики, переконайтеся, що ви знаходитесь в кореневій теці клонованого репозиторію Kubernetes. Потім виконайте наступну команду:

```shell
./test/instrumentation/update-documentation.sh
```

Щоб перевірити наявність змін, виконайте команду:

```shell
git status
```

Вивід буде схожий на:

```none
./test/instrumentation/documentation/documentation.md
./test/instrumentation/documentation/documentation-list.yaml
```

## Скопіюйте згенерований файл документації для метрик в репозиторій вебсайту Kubernetes {#copy-the-generated-metrics-documentation-to-the-kubernetes-website-repository}

1. Встановіть змінну середовища для кореневої теки вебсайту Kubernetes.

   Виконайте наступну команду, щоб встановити кореневу теку вебсайту:

   ```shell
   export WEBSITE_ROOT=<шлях до кореня вебсайту>
   ```

2. Скопіюйте згенерований файл метрик в репозиторій вебсайту Kubernetes.

   ```shell
   cp ./test/instrumentation/documentation/documentation.md "${WEBSITE_ROOT}/content/en/docs/reference/instrumentation/metrics.md"
   ```

   
<div class="alert alert-info" role="note"><h4 class="alert-heading">Примітка:</h4>Якщо ви отримали помилку, перевірте, чи маєте ви дозволи на копіювання файлу. Ви можете використати <code>chown</code>, щоб змінити власника файлу на вашого користувача.</div>


## Створіть pull request {#create-a-pull-request}

Щоб створити pull request, дотримуйтесь інструкцій у розділі [Відкриття pull request](/docs/contribute/new-content/open-a-pr/).

## Що далі

* [Внесок у код Kubernetes](/docs/contribute/generate-ref-docs/contribute-upstream/)
* [Генерація довідкової документації для компонентів і інструментів Kubernetes](/docs/contribute/generate-ref-docs/kubernetes-components/)
* [Генерація довідкової документації для команд kubectl](/docs/contribute/generate-ref-docs/kubectl/)