|
| 1 | +--- |
| 2 | +title: Generowanie materiałów źródłowych dla polecenia kubectl |
| 3 | +content_type: task |
| 4 | +weight: 90 |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- overview --> |
| 8 | + |
| 9 | +Ta strona pokazuje, jak wygenerować materiały źródłowe polecenia `kubectl`. |
| 10 | + |
| 11 | +{{< note >}} |
| 12 | +Ten temat pokazuje, jak wygenerować materiały źródłowe dla |
| 13 | +[poleceń kubectl](/docs/reference/generated/kubectl/kubectl-commands) takich jak |
| 14 | +[kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) i |
| 15 | +[kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint). |
| 16 | +Ten temat nie pokazuje, jak wygenerować stronę materiałów źródłowych opcji [kubectl](/docs/reference/generated/kubectl/kubectl-commands/). |
| 17 | +Aby |
| 18 | +uzyskać instrukcje dotyczące generowania strony materiałów źródłowych opcji |
| 19 | +kubectl, zobacz [Generowanie stron materiałów źródłowych dla komponentów i narzędzi Kubernetesa](/docs/contribute/generate-ref-docs/kubernetes-components/). |
| 20 | + |
| 21 | +{{< /note >}} |
| 22 | + |
| 23 | +## {{% heading "prerequisites" %}} |
| 24 | + |
| 25 | +{{< include "prerequisites-ref-docs.md" >}} |
| 26 | + |
| 27 | +<!-- steps --> |
| 28 | + |
| 29 | +## Skonfiguruj lokalne repozytoria {#set-up-the-local-repositories} |
| 30 | + |
| 31 | +Utwórz lokalną przestrzeń roboczą i ustaw swoje `GOPATH`: |
| 32 | + |
| 33 | +```shell |
| 34 | +mkdir -p $HOME/<workspace> |
| 35 | + |
| 36 | +export GOPATH=$HOME/<workspace> |
| 37 | +``` |
| 38 | + |
| 39 | +Utwórz lokalną kopię następujących repozytoriów: |
| 40 | + |
| 41 | +```shell |
| 42 | +go get -u github.com/spf13/pflag |
| 43 | +go get -u github.com/spf13/cobra |
| 44 | +go get -u gopkg.in/yaml.v2 |
| 45 | +go get -u github.com/kubernetes-sigs/reference-docs |
| 46 | +``` |
| 47 | + |
| 48 | +Jeśli nie masz jeszcze repozytorium kubernetes/website, pobierz je teraz: |
| 49 | + |
| 50 | +```shell |
| 51 | +git clone https://github.com/<your-username>/website $GOPATH/src/github.com/<your-username>/website |
| 52 | +``` |
| 53 | + |
| 54 | +Zrób klon repozytorium kubernetes/kubernetes jako k8s.io/kubernetes: |
| 55 | + |
| 56 | +```shell |
| 57 | +git clone https://github.com/kubernetes/kubernetes $GOPATH/src/k8s.io/kubernetes |
| 58 | +``` |
| 59 | + |
| 60 | +Usuń pakiet spf13 z `$GOPATH/src/k8s.io/kubernetes/vendor/github.com`: |
| 61 | + |
| 62 | +```shell |
| 63 | +rm -rf $GOPATH/src/k8s.io/kubernetes/vendor/github.com/spf13 |
| 64 | +``` |
| 65 | + |
| 66 | +Repozytorium kubernetes/kubernetes dostarcza kod źródłowy `kubectl` oraz `kustomize`. |
| 67 | + |
| 68 | +* Określ katalog bazowy twojej kopii repozytorium |
| 69 | + [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes). Na przykład, |
| 70 | + jeśli postępowałeś zgodnie z poprzednim krokiem, aby pobrać |
| 71 | + repozytorium, twój katalog bazowy to `$GOPATH/src/k8s.io/kubernetes`. |
| 72 | + Kolejne kroki odwołują się do twojego katalogu bazowego jako `<k8s-base>`. |
| 73 | + |
| 74 | +* Określ katalog bazowy klonu Twojego repozytorium |
| 75 | + [kubernetes/website](https://github.com/kubernetes/website). Na przykład, jeśli |
| 76 | + wykonałeś poprzedni krok, aby pobrać repozytorium, Twoim katalogiem bazowym |
| 77 | + jest `$GOPATH/src/github.com/<your-username>/website`. |
| 78 | + Kolejne kroki odnoszą się do Twojego katalogu bazowego jako `<web-base>`. |
| 79 | + |
| 80 | +* Określ katalog główny dla Twojej kopii repozytorium |
| 81 | + [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs). Na przykład, |
| 82 | + jeśli postępowałeś zgodnie z poprzednim krokiem, aby uzyskać repozytorium, |
| 83 | + Twoim katalogiem głównym będzie `$GOPATH/src/github.com/kubernetes-sigs/reference-docs`. |
| 84 | + Dalsze kroki odnoszą się do Twojego katalogu głównego jako `<rdocs-base>`. |
| 85 | + |
| 86 | +W swoim lokalnym repozytorium k8s.io/kubernetes przejdź do interesującej Cię |
| 87 | +gałęzi i upewnij się, że jest ona aktualna. Na przykład, jeśli chcesz wygenerować |
| 88 | +dokumentację dla Kubernetesa {{< skew prevMinorVersion >}}.0, możesz użyć tych poleceń: |
| 89 | + |
| 90 | +```shell |
| 91 | +cd <k8s-base> |
| 92 | +git checkout v{{< skew prevMinorVersion >}}.0 |
| 93 | +git pull https://github.com/kubernetes/kubernetes {{< skew prevMinorVersion >}}.0 |
| 94 | +``` |
| 95 | + |
| 96 | +Jeśli nie musisz edytować kodu źródłowego `kubectl`, postępuj zgodnie z |
| 97 | +instrukcjami dotyczącymi [Ustawiania zmiennych kompilacji](#setting-build-variables). |
| 98 | + |
| 99 | +## Edytowanie kodu źródłowego kubectl {#edit-the-kubectl-source-code} |
| 100 | + |
| 101 | +Materiały źródłowe polecenia kubectl są automatycznie generowana z kodu źródłowego kubectl. |
| 102 | +Jeśli chcesz zmienić materiały źródłowe, pierwszym krokiem jest zmiana |
| 103 | +jednego lub więcej komentarzy w kodzie źródłowym kubectl. Wprowadź zmianę w swoim |
| 104 | +lokalnym repozytorium kubernetes/kubernetes, a następnie zgłoś pull requesta do |
| 105 | +gałęzi master na [github.com/kubernetes/kubernetes](https://github.com/kubernetes/kubernetes). |
| 106 | + |
| 107 | +[PR 56673](https://github.com/kubernetes/kubernetes/pull/56673/files) jest |
| 108 | +przykładem pull requesta, który poprawia literówkę w kodzie źródłowym kubectl. |
| 109 | + |
| 110 | +Monitoruj swój pull request (PR) i odpowiadaj na komentarze recenzentów. Kontynuuj |
| 111 | +monitorowanie swojego PR, aż zostanie scalony z docelową gałęzią w repozytorium kubernetes/kubernetes. |
| 112 | + |
| 113 | +## Zrób cherry pick do gałęzi wydania {#cherry-pick-your-change-into-a-release-branch} |
| 114 | + |
| 115 | +Twoja zmiana znajduje się teraz w głównej gałęzi, która jest używana do |
| 116 | +rozwoju następnego wydania Kubernetesa. Jeśli chcesz, aby twoja |
| 117 | +zmiana pojawiła się w wersji dokumentacji Kubernetesa, która została już |
| 118 | +wydana, musisz zaproponować włączenie twojej zmiany do gałęzi wydania. |
| 119 | + |
| 120 | +Na przykład, załóżmy, że gałąź master jest używana do rozwijania Kubernetes |
| 121 | +{{< skew currentVersion >}} i chcesz przenieść swoją zmianę do gałęzi |
| 122 | +release-{{< skew prevMinorVersion >}}. Aby uzyskać instrukcje, jak to zrobić, zobacz |
| 123 | +[Proponowanie Cherry Pick](https://git.k8s.io/community/contributors/devel/sig-release/cherry-picks.md). |
| 124 | + |
| 125 | +Monitoruj swój cherry pick pull request, aż zostanie scalone z gałęzią wydania. |
| 126 | + |
| 127 | +{{< note >}} |
| 128 | +Proponowanie cherry pick wymaga posiadania uprawnień do ustawiania etykiety oraz |
| 129 | +kamienia milowego w swoim pull requeście. Jeśli nie posiadasz tych uprawnień, |
| 130 | +będziesz musiał współpracować z kimś, kto może ustawić etykietę i kamień milowy za Ciebie. |
| 131 | +{{< /note >}} |
| 132 | + |
| 133 | +## Ustaw zmienne budowania {#set-build-variables} |
| 134 | + |
| 135 | +Przejdź do `<rdocs-base>`. W swoim wierszu poleceń ustaw następujące zmienne środowiskowe. |
| 136 | + |
| 137 | +* Ustaw `K8S_ROOT` na `<k8s-base>`. |
| 138 | +* Ustaw `K8S_WEBROOT` na `<web-base>`. |
| 139 | +* Ustaw `K8S_RELEASE` na wersję dokumentacji, którą chcesz zbudować. Na przykład, |
| 140 | + jeśli chcesz zbudować dokumentację dla Kubernetesa |
| 141 | + {{< skew prevMinorVersion >}}, ustaw `K8S_RELEASE` na {{< skew prevMinorVersion >}}. |
| 142 | + |
| 143 | +Na przykład: |
| 144 | + |
| 145 | +```shell |
| 146 | +export K8S_WEBROOT=$GOPATH/src/github.com/<your-username>/website |
| 147 | +export K8S_ROOT=$GOPATH/src/k8s.io/kubernetes |
| 148 | +export K8S_RELEASE={{< skew prevMinorVersion >}} |
| 149 | +``` |
| 150 | + |
| 151 | +## Tworzenie katalogu wersjonowanego {#creating-a-versioned-directory} |
| 152 | + |
| 153 | +Uruchomienie budowania (ang. build target) `createversiondirs` tworzy katalog z |
| 154 | +wersjonowaniem i kopiuje pliki konfiguracyjne kubectl dotyczące materiałów źródłowych do tego |
| 155 | +katalogu. Nazwa katalogu z wersjonowaniem jest zgodna z wzorcem `v<major>_<minor>`. |
| 156 | + |
| 157 | +W katalogu `<rdocs-base>`, uruchom następujący cel budowania: |
| 158 | + |
| 159 | +```shell |
| 160 | +cd <rdocs-base> |
| 161 | +make createversiondirs |
| 162 | +``` |
| 163 | + |
| 164 | +## Sprawdź tag wydania w k8s.io/kubernetes {#check-out-a-release-tag-in-k8siokubernetes} |
| 165 | + |
| 166 | +W swoim lokalnym repozytorium `<k8s-base>`, przejdź do gałęzi, która zawiera |
| 167 | +wersję Kubernetesa, którą chcesz udokumentować. Na przykład, jeśli chcesz |
| 168 | +wygenerować dokumentację dla Kubernetesa {{< skew prevMinorVersion >}}.0, przejdź do tagu `v{{< skew prevMinorVersion >}}`. |
| 169 | +Upewnij się, że Twoja lokalna gałąź jest aktualna. |
| 170 | + |
| 171 | +```shell |
| 172 | +cd <k8s-base> |
| 173 | +git checkout v{{< skew prevMinorVersion >}}.0 |
| 174 | +git pull https://github.com/kubernetes/kubernetes v{{< skew prevMinorVersion >}}.0 |
| 175 | +``` |
| 176 | + |
| 177 | +## Uruchom kod generowania dokumentacji {#run-the-doc-generation-code} |
| 178 | + |
| 179 | +W lokalnym katalogu `<rdocs-base>`, uruchom cel budowania (ang. build target) `copycli`. Komenda działa z uprawnieniami `root`: |
| 180 | + |
| 181 | +```shell |
| 182 | +cd <rdocs-base> |
| 183 | +make copycli |
| 184 | +``` |
| 185 | + |
| 186 | +Polecenie `copycli` czyści tymczasowy katalog kompilacji, generuje pliki poleceń kubectl i |
| 187 | +kopiuje zbiorczą stronę HTML materiałów źródłowych poleceń kubectl oraz zasoby do `<web-base>`. |
| 188 | + |
| 189 | +## Zlokalizuj wygenerowane pliki {#locate-the-generated-files} |
| 190 | + |
| 191 | +Zweryfikuj, czy te dwa pliki zostały wygenerowane: |
| 192 | + |
| 193 | +```shell |
| 194 | +[ -e "<rdocs-base>/gen-kubectldocs/generators/build/index.html" ] && echo "index.html built" || echo "no index.html" |
| 195 | +[ -e "<rdocs-base>/gen-kubectldocs/generators/build/navData.js" ] && echo "navData.js built" || echo "no navData.js" |
| 196 | +``` |
| 197 | + |
| 198 | +## Zlokalizuj skopiowane pliki {#locate-the-copied-files} |
| 199 | + |
| 200 | +Zweryfikuj, czy wszystkie wygenerowane pliki zostały skopiowane do Twojego `<web-base>`: |
| 201 | + |
| 202 | +```shell |
| 203 | +cd <web-base> |
| 204 | +git status |
| 205 | +``` |
| 206 | + |
| 207 | +Wynik powinien zawierać zmodyfikowane pliki: |
| 208 | + |
| 209 | +``` |
| 210 | +static/docs/reference/generated/kubectl/kubectl-commands.html |
| 211 | +static/docs/reference/generated/kubectl/navData.js |
| 212 | +``` |
| 213 | + |
| 214 | +Wynik może również zawierać: |
| 215 | + |
| 216 | +``` |
| 217 | +static/docs/reference/generated/kubectl/scroll.js |
| 218 | +static/docs/reference/generated/kubectl/stylesheet.css |
| 219 | +static/docs/reference/generated/kubectl/tabvisibility.js |
| 220 | +static/docs/reference/generated/kubectl/node_modules/bootstrap/dist/css/bootstrap.min.css |
| 221 | +static/docs/reference/generated/kubectl/node_modules/highlight.js/styles/default.css |
| 222 | +static/docs/reference/generated/kubectl/node_modules/jquery.scrollto/jquery.scrollTo.min.js |
| 223 | +static/docs/reference/generated/kubectl/node_modules/jquery/dist/jquery.min.js |
| 224 | +static/docs/reference/generated/kubectl/node_modules/font-awesome/css/font-awesome.min.css |
| 225 | +``` |
| 226 | + |
| 227 | +## Lokalne testowanie dokumentacji {#locally-test-the-documentation} |
| 228 | + |
| 229 | +Zbuduj dokumentację Kubernetes w lokalnym `<web-base>`. |
| 230 | + |
| 231 | +```shell |
| 232 | +cd <web-base> |
| 233 | +git submodule update --init --recursive --depth 1 # if not already done |
| 234 | +make container-serve |
| 235 | +``` |
| 236 | + |
| 237 | +Zobacz [podgląd lokalny](https://localhost:1313/docs/reference/generated/kubectl/kubectl-commands/). |
| 238 | + |
| 239 | +## Dodaj i zatwierdź zmiany w kubernetes/website {#add-and-commit-changes-in-kuberneteswebsite} |
| 240 | + |
| 241 | +Uruchom `git add` i `git commit`, aby zatwierdzić pliki. |
| 242 | + |
| 243 | +## Utwórz pull requesta {#create-a-pull-request} |
| 244 | + |
| 245 | +Utwórz pull requesta do repozytorium `kubernetes/website`. |
| 246 | +Monitoruj swój pull request i odpowiadaj na komentarze z przeglądu. |
| 247 | +Kontynuuj monitorowanie swojego pull requesta aż do momentu jego włączenia do głównej gałęzi kodu. |
| 248 | + |
| 249 | +Kilka minut po włączeniu twojego pull requesta, zaktualizowane tematy |
| 250 | +materiałów źródłowych będą widoczne w [opublikowanej dokumentacji](/docs/home). |
| 251 | + |
| 252 | +## {{% heading "whatsnext" %}} |
| 253 | + |
| 254 | +* [Szybki start generowania materiałów źródłowych](/docs/contribute/generate-ref-docs/quickstart/) |
| 255 | +* [Generowanie materiałów źródłowych dla komponentów i narzędzi Kubernetesa](/docs/contribute/generate-ref-docs/kubernetes-components/) |
| 256 | +* [Generowanie materiałów źródłowych dla Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/) |
0 commit comments