# Generowanie materiałów źródłowych dla metryk

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

---

<!-- overview -->

Ta strona demonstruje generowanie materiałów źródłowych dotyczących metryk.

## Zanim zaczniesz


	<h3 id="requirements">Wymagania:<a class="td-heading-self-link" href="#requirements" aria-label="Heading self-link"></a></h3>
<ul>
<li>
<p>Potrzebujesz maszyny z systemem operacyjnym Linux lub macOS. W systemie Windows
użyj <a href="https://learn.microsoft.com/en-us/windows/wsl/install">Windows Subsystem for Linux (WSL)</a>,
ponieważ narzędzia do budowania opierają się na <code>make</code> i skryptach Bash.</p>
</li>
<li>
<p>Musisz mieć zainstalowane następujące narzędzia:</p>
<ul>
<li><a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git</a> - Dokumentacja opisuje, jak zainstalować i rozpocząć pracę z systemem kontroli wersji <code>Git</code>.</li>
<li><a href="https://go.dev/dl/">Go</a>, dowolna aktualna wersja (Go automatycznie pobiera dokładnie taki zestaw narzędzi, jakiego potrzebuje generator)</li>
<li><a href="https://www.gnu.org/software/make/">make</a></li>
<li><a href="https://gcc.gnu.org/">gcc compiler/linker</a></li>
<li><a href="https://docs.docker.com/engine/installation/">Docker</a> (wymagany tylko do lokalnego podglądu strony za pomocą <code>make container-serve</code>)</li>
</ul>
</li>
<li>
<p>Musisz wiedzieć, jak utworzyć pull requesta do repozytorium na GitHubie.
Wymaga to utworzenia własnego forka repozytorium. Aby uzyskać więcej informacji,
zobacz <a href="/docs/contribute/new-content/open-a-pr/#fork-the-repo">Praca z lokalnej kopii</a>.</p>
</li>
</ul>


<!-- steps -->

## Sklonuj repozytorium Kubernetesa {#clone-the-kubernetes-repository}

Generowanie metryk odbywa się w repozytorium Kubernetesa. Aby
sklonować repozytorium, przejdź do katalogu, w którym chcesz, aby klon istniał.

Następnie wykonaj następujące polecenie:

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

To tworzy folder `kubernetes` w bieżącym katalogu roboczym.

## Generowanie metryk {#generate-the-metrics}

W sklonowanym repozytorium Kubernetesa
zlokalizuj katalog `test/instrumentation/documentation`.
Dokumentacja metryk jest generowana w tym katalogu.

Przy każdej wersji dodawane są nowe metryki. Po
uruchomieniu skryptu generatora dokumentacji metryk,
skopiuj dokumentację metryk na stronę internetową
Kubernetesa i opublikuj zaktualizowaną dokumentację metryk.

Aby wygenerować najnowsze metryki, upewnij się, że znajdujesz się w katalogu
głównym sklonowanego katalogu Kubernetesa. Następnie wykonaj następujące polecenie:

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

Aby sprawdzić zmiany, wykonaj:

```shell
git status
```

Wynik jest podobny do:

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

## Skopiuj wygenerowany plik dokumentacji metryk do repozytorium strony internetowej Kubernetesa {#copy-the-generated-metrics-documentation-file-to-the-kubernetes-website-repository}

1. Ustaw zmienną środowiskową głównego katalogu strony Kubernetesa.

   Wykonaj następujące polecenie, aby ustawić główny katalog witryny:

   ```shell
   export WEBSITE_ROOT=<path to website root>
   ```

2. Skopiuj wygenerowany plik metryk do repozytorium witryny Kubernetesa.

   ```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">Informacja:</h4>Jeśli pojawi się błąd, sprawdź, czy masz uprawnienia do skopiowania
pliku. Możesz użyć <code>chown</code>, aby zmienić własność pliku na swojego użytkownika.</div>


## Utwórz pull requesta {#create-a-pull-request}

Aby utworzyć pull request, postępuj zgodnie z instrukcjami w [Otwarcie pull requesta](/docs/contribute/new-content/open-a-pr/).

## Co dalej?

* [Współpraca z głównym projektem](/docs/contribute/generate-ref-docs/contribute-upstream/)
* [Generowanie materiałów źródłowych dla komponentów i narzędzi Kubernetesa](/docs/contribute/generate-ref-docs/kubernetes-components/)
* [Generowanie materiałów źródłowych dla poleceń kubectl](/docs/contribute/generate-ref-docs/kubectl/)