Skip to content

Commit c2a6e2d

Browse files
committed
[pl] docs/contribute/generate-ref-docs/kubernetes-api.md
1 parent dd6c1ff commit c2a6e2d

File tree

3 files changed

+223
-0
lines changed

3 files changed

+223
-0
lines changed
Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
---
2+
title: Generowanie materiałów źródłowych dla API Kubernetesa
3+
content_type: task
4+
weight: 50
5+
---
6+
7+
<!-- overview -->
8+
9+
Ta strona pokazuje, jak zaktualizować materiały źródłowe API Kubernetes.
10+
11+
Dokumentacja materiałów źródłowych API Kubernetesa jest tworzona na podstawie
12+
[specyfikacji OpenAPI Kubernetes](https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json) przy
13+
użyciu kodu generującego [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs).
14+
15+
Jeśli znajdziesz błędy w wygenerowanej dokumentacji, musisz je
16+
[naprawić w pierwotnym źródle](/docs/contribute/generate-ref-docs/contribute-upstream/).
17+
18+
Jeśli potrzebujesz jedynie wygenerować na nowo
19+
materiały źródłowe z [OpenAPI](https://github.com/OAI/OpenAPI-Specification)
20+
specyfikacji, kontynuuj czytanie tej strony.
21+
22+
## {{% heading "prerequisites" %}}
23+
24+
{{< include "prerequisites-ref-docs.md" >}}
25+
26+
<!-- steps -->
27+
28+
## Skonfiguruj lokalne repozytoria {#set-up-the-local-repositories}
29+
30+
Utwórz lokalne środowisko robocze i ustaw `GOPATH`:
31+
32+
```shell
33+
mkdir -p $HOME/<workspace>
34+
35+
export GOPATH=$HOME/<workspace>
36+
```
37+
38+
Pobierz lokalną kopię następujących repozytoriów:
39+
40+
```shell
41+
go get -u github.com/kubernetes-sigs/reference-docs
42+
43+
go get -u github.com/go-openapi/loads
44+
go get -u github.com/go-openapi/spec
45+
```
46+
47+
Jeśli nie masz jeszcze repozytorium kubernetes/website, pobierz je teraz:
48+
49+
```shell
50+
git clone https://github.com/<your-username>/website $GOPATH/src/github.com/<your-username>/website
51+
```
52+
53+
Zrób klon repozytorium kubernetes/kubernetes jako k8s.io/kubernetes:
54+
55+
```shell
56+
git clone https://github.com/kubernetes/kubernetes $GOPATH/src/k8s.io/kubernetes
57+
```
58+
59+
* Główny katalog twojego klonu repozytorium
60+
[kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) to
61+
`$GOPATH/src/k8s.io/kubernetes.` Kolejne kroki odnoszą
62+
się do twojego głównego katalogu jako `<k8s-base>`.
63+
64+
* Główny katalog klonu repozytorium
65+
[kubernetes/website](https://github.com/kubernetes/website) znajduje się w
66+
`$GOPATH/src/github.com/<twoja nazwa użytkownika>/website`. W
67+
kolejnych krokach główny katalog będzie określany jako `<web-base>`.
68+
69+
* Główny katalog twojego klonu repozytorium
70+
[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) znajduje się
71+
w `$GOPATH/src/github.com/kubernetes-sigs/reference-docs`.
72+
W dalszych krokach główny katalog będzie oznaczany jako `<rdocs-base>`.
73+
74+
## Generuj materiały źródłowe API {#generate-the-api-reference-docs}
75+
76+
Ta sekcja pokazuje, jak wygenerować [opublikowane materiały źródłowe API
77+
Kubernetesa](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/).
78+
79+
### Ustaw zmienne budowania {#set-build-variables}
80+
81+
* Ustaw `K8S_ROOT` na `<k8s-base>`.
82+
* Ustaw `K8S_WEBROOT` na `<web-base>`.
83+
* Ustaw `K8S_RELEASE` na wersję dokumentacji, którą chcesz zbudować. Na przykład,
84+
jeśli chcesz zbudować dokumentację dla Kubernetesa 1.17.0, ustaw `K8S_RELEASE` na 1.17.0.
85+
86+
Na przykład:
87+
88+
```shell
89+
export K8S_WEBROOT=${GOPATH}/src/github.com/<your-username>/website
90+
export K8S_ROOT=${GOPATH}/src/k8s.io/kubernetes
91+
export K8S_RELEASE=1.17.0
92+
```
93+
94+
### Utwórz wersjonowany katalog i pobierz specyfikację Open API {#create-versioned-directory-and-fetch-open-api-spec}
95+
96+
Celem kompilacji `updateapispec` jest stworzenie wersjonowanego
97+
katalogu kompilacji. Po utworzeniu katalogu, specyfikacja Open API pobierana jest
98+
z repozytorium `<k8s-base>`. Te kroki gwarantują, że wersje
99+
plików konfiguracyjnych i specyfikacji Open API Kubernetes są zgodne z
100+
wersją wydania. Nazwa wersjonowanego katalogu przyjmuje wzór `v<major>_<minor>`.
101+
102+
W katalogu `<rdocs-base>`, uruchom następujący cel buildowania (ang. build target):
103+
104+
```shell
105+
cd <rdocs-base>
106+
make updateapispec
107+
```
108+
109+
### Zbuduj materiały źródłowe API {#build-the-api-reference-docs}
110+
111+
Celem `copyapi` jest zbudowanie materiałów źródłowych
112+
API i skopiowanie wygenerowanych plików do katalogów w
113+
`<web-base>`. Wykonaj następujące polecenie w `<rdocs-base>`:
114+
115+
```shell
116+
cd <rdocs-base>
117+
make copyapi
118+
```
119+
120+
Zweryfikuj, czy te dwa pliki zostały wygenerowane:
121+
122+
```shell
123+
[ -e "<rdocs-base>/gen-apidocs/build/index.html" ] && echo "index.html built" || echo "no index.html"
124+
[ -e "<rdocs-base>/gen-apidocs/build/navData.js" ] && echo "navData.js built" || echo "no navData.js"
125+
```
126+
127+
Przejdź do podstawowej lokalizacji lokalnego
128+
`<web-base>` i sprawdź, które pliki zostały zmodyfikowane:
129+
130+
```shell
131+
cd <web-base>
132+
git status
133+
```
134+
135+
Wynik jest podobny do:
136+
137+
```
138+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/bootstrap.min.css
139+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/font-awesome.min.css
140+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/stylesheet.css
141+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/FontAwesome.otf
142+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.eot
143+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.svg
144+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.ttf
145+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.woff
146+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.woff2
147+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/index.html
148+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/jquery.scrollTo.min.js
149+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/navData.js
150+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/scroll.js
151+
```
152+
153+
## Zaktualizuj strony indeksu materiałów źródłowych API {#update-the-api-reference-index-pages}
154+
155+
Podczas generowania materiałów źródłowych dla nowego
156+
wydania, zaktualizuj plik `<web-base>/content/en/docs/reference/kubernetes-api/api-index.md`
157+
o nowy numer wersji.
158+
159+
* Otwórz `<web-base>/content/en/docs/reference/kubernetes-api/api-index.md` do
160+
edycji i zaktualizuj numer wersji materiałów źródłowych API. Na przykład:
161+
162+
```
163+
---
164+
title: v1.17
165+
---
166+
167+
[Kubernetes API v1.17](/docs/reference/generated/kubernetes-api/v1.17/)
168+
```
169+
170+
* Otwórz `<web-base>/content/en/docs/reference/_index.md` do edycji i dodaj nowe łącze
171+
do najnowszych materiałów źródłowych API. Usuń najstarszą wersję
172+
materiałów źródłowych API. Powinno być pięć łączy do najnowszych materiałów źródłowych API.
173+
174+
## Lokalne testowanie materiałów źródłowych API {#locally-test-the-api-reference}
175+
176+
Opublikuj lokalną wersję materiałów źródłowych API. Zweryfikuj [lokalny
177+
podgląd](http://localhost:1313/docs/reference/generated/kubernetes-api/{{< param "version">}}/).
178+
179+
```shell
180+
cd <web-base>
181+
git submodule update --init --recursive --depth 1 # if not already done
182+
make container-serve
183+
```
184+
185+
## Zatwierdź zmiany {#commit-the-changes}
186+
187+
W `<web-base>` uruchom `git add` oraz `git commit`, aby zatwierdzić zmiany.
188+
189+
Prześlij swoje zmiany jako [pull request](/docs/contribute/new-content/open-a-pr/)
190+
do repozytorium
191+
[kubernetes/website](https://github.com/kubernetes/website). Monitoruj swój pull
192+
request i odpowiadaj na komentarze recenzentów według potrzeb.
193+
Kontynuuj monitorowanie swojego pull requesta do momentu jego scalenia.
194+
195+
## {{% heading "whatsnext" %}}
196+
197+
* [Szybki start generowania materiałów źródłowych](/docs/contribute/generate-ref-docs/quickstart/)
198+
* [Generowanie materiałów źródłowych dla komponentów i narzędzi Kubernetesa](/docs/contribute/generate-ref-docs/kubernetes-components/)
199+
* [Generowanie materiałów źródłowych dla komend kubectl](/docs/contribute/generate-ref-docs/kubectl/)
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
### Wymagania: {#requirements}
3+
4+
- Potrzebujesz maszyny z systemem operacyjnym Linux lub macOS.
5+
6+
- Musisz mieć zainstalowane następujące narzędzia:
7+
8+
- [Python](https://www.python.org/downloads/) w wersji 3.7.x+
9+
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - Dokumentacja opisuje, jak zainstalować i rozpocząć pracę z systemem kontroli wersji `Git`.
10+
- [Golang](https://go.dev/dl/) wersja 1.13+
11+
- [Pip](https://pypi.org/project/pip/) używany do instalacji PyYAML
12+
- [PyYAML](https://pyyaml.org/) w wersji 5.1.2
13+
- [make](https://www.gnu.org/software/make/)
14+
- [gcc compiler/linker](https://gcc.gnu.org/)
15+
- [Docker](https://docs.docker.com/engine/installation/) (Wymagany tylko do odniesień do poleceń `kubectl`)
16+
17+
- Twoja zmienna środowiskowa `PATH` musi zawierać wymagane narzędzia do budowania, takie jak binaria `Go` i `python`.
18+
19+
- Musisz wiedzieć, jak utworzyć pull requesta do repozytorium na GitHubie.
20+
Wymaga to utworzenia własnego forka repozytorium. Aby uzyskać więcej informacji,
21+
zobacz [Praca z lokalnej kopii](/docs/contribute/new-content/open-a-pr/#fork-the-repo).

content/pl/includes/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
headless: true
3+
---

0 commit comments

Comments
 (0)