|
| 1 | +--- |
| 2 | +title: Typy treści |
| 3 | +content_type: concept |
| 4 | +weight: 80 |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- overview --> |
| 8 | + |
| 9 | +Dokumentacja Kubernetesa obejmuje kilka typów treści stron: |
| 10 | + |
| 11 | +- Pojęcia i koncepcje (ang. Concept) |
| 12 | +- Zadanie (ang. Task) |
| 13 | +- Samouczek (ang. Tutorial) |
| 14 | +- Materiały źródłowe (ang. Reference) |
| 15 | + |
| 16 | +<!-- body --> |
| 17 | + |
| 18 | +## Sekcje treści {#content-sections} |
| 19 | + |
| 20 | +Każdy typ strony zawiera szereg sekcji zdefiniowanych przez |
| 21 | +komentarze Markdown i nagłówki HTML. Możesz dodać nagłówki |
| 22 | +do swojej strony za pomocą kodu `heading`. Komentarze i |
| 23 | +nagłówki pomagają utrzymać odpowiednią strukturę strony dla danego typu. |
| 24 | + |
| 25 | +Przykłady komentarzy w Markdown definiujących sekcje strony: |
| 26 | + |
| 27 | +```markdown |
| 28 | +<!-- overview --> |
| 29 | +``` |
| 30 | + |
| 31 | +```markdown |
| 32 | +<!-- body --> |
| 33 | +``` |
| 34 | + |
| 35 | +Aby utworzyć typowe nagłówki na swoich |
| 36 | +stronach, użyj kodu `heading` z nazwą nagłówka. |
| 37 | + |
| 38 | +Przykłady nazw nagłówków: |
| 39 | + |
| 40 | +- whatsnext - co dalej |
| 41 | +- prerequisites - wymagania wstępne |
| 42 | +- objectives - cele |
| 43 | +- cleanup - sprzątanie |
| 44 | +- synopsis - streszczenie |
| 45 | +- seealso - zobacz także |
| 46 | +- options - opcje |
| 47 | + |
| 48 | +Na przykład, aby utworzyć nagłówek `whatsnext`, dodaj kod nagłówka z nazwą "whatsnext": |
| 49 | + |
| 50 | +```none |
| 51 | +## {{%/* heading "whatsnext" */%}} |
| 52 | +``` |
| 53 | + |
| 54 | +Możesz zadeklarować nagłówek `prerequisites` w następujący sposób: |
| 55 | + |
| 56 | +```none |
| 57 | +## {{%/* heading "prerequisites" */%}} |
| 58 | +``` |
| 59 | + |
| 60 | +Kod `heading` oczekuje jednego parametru typu |
| 61 | +string. Ten parametr nagłówka odpowiada prefiksowi zmiennej |
| 62 | +w plikach `i18n/<lang>.toml`. Na przykład: |
| 63 | + |
| 64 | +`` `i18n/en.toml`:` `` |
| 65 | + |
| 66 | +```toml |
| 67 | +[whatsnext_heading] |
| 68 | +other = "What's next" |
| 69 | +``` |
| 70 | + |
| 71 | +`i18n/ko.toml`: |
| 72 | + |
| 73 | +```toml |
| 74 | +[whatsnext_heading] |
| 75 | +other = "다음 내용" |
| 76 | +``` |
| 77 | + |
| 78 | +## Typy zawartości {#content-types} |
| 79 | + |
| 80 | +Każdy typ zawartości nieformalnie definiuje swoją oczekiwaną strukturę |
| 81 | +strony. Twórz zawartość strony, korzystając z sugerowanych sekcji strony. |
| 82 | + |
| 83 | +### Pojęcie (ang. Concept) {#concept} |
| 84 | + |
| 85 | +Strona z pojęciami wyjaśnia określony aspekt Kubernetesa. Na |
| 86 | +przykład, strona koncepcyjna może opisywać obiekt Deployment w |
| 87 | +Kubernetesie i wyjaśniać jego rolę jako aplikacji po wdrożeniu, |
| 88 | +skalowaniu i aktualizacji. Zazwyczaj strony koncepcyjne nie |
| 89 | +zawierają instrukcji krok po kroku, lecz odsyłają do zadań lub samouczków. |
| 90 | + |
| 91 | +Aby napisać nową stronę z pojęciem, utwórz plik Markdown w |
| 92 | +podkatalogu katalogu `/content/en/docs/concepts`, z następującymi sekcjami: |
| 93 | + |
| 94 | +Strony koncepcyjne są podzielone na trzy sekcje: |
| 95 | + |
| 96 | +| Sekcja strony | |
| 97 | +|------------------------------| |
| 98 | +| overview - przegląd | |
| 99 | +| body - treść | |
| 100 | +| whatsnext - co dalej | |
| 101 | + |
| 102 | +Sekcje `overview` i `body` pojawiają się jako komentarze na stronie z |
| 103 | +koncepcjami. Możesz dodać sekcję `whatsnext` do swojej strony za pomocą kodu `heading`. |
| 104 | + |
| 105 | +Wypełnij każdą sekcję treścią. Postępuj zgodnie z tymi wytycznymi: |
| 106 | + |
| 107 | +- Organizuj treści za pomocą nagłówków H2 i H3. |
| 108 | +- Dla `overview`, ustaw kontekst tematu za pomocą pojedynczego akapitu. |
| 109 | +- Dla `body` wyjaśnij koncepcję. |
| 110 | +- Dla `whatsnext`, podaj wypunktowaną listę tematów (maksymalnie 5), aby dowiedzieć się więcej o koncepcji. |
| 111 | + |
| 112 | +Strona [adnotacje](/docs/concepts/overview/working-with-objects/annotations/) jest opublikowanym przykładem strony koncepcyjnej. |
| 113 | + |
| 114 | +### Zadanie (ang. Task) {#task} |
| 115 | + |
| 116 | +Strony opisujące wykonywanie zadań zawierają minimum |
| 117 | +wyjaśnień, ale zwykle podają odnośniki do |
| 118 | +dokumentacji objaśniającej pojęcia i szerszy kontekst danego tematu. |
| 119 | + |
| 120 | +Aby napisać nową stronę zadania, utwórz plik Markdown w |
| 121 | +podkatalogu katalogu `/content/en/docs/tasks`, z następującymi sekcjami: |
| 122 | + |
| 123 | +| Sekcja strony | |
| 124 | +|------------------------------| |
| 125 | +| overview - przegląd | |
| 126 | +| prerequisites - wymagania wstępne | |
| 127 | +| steps - kroki | |
| 128 | +| discussion - dyskusja | |
| 129 | +| whatsnext - co dalej | |
| 130 | + |
| 131 | +Sekcje `overview`, `steps` i `discussion` pojawiają się jako komentarze |
| 132 | +na stronie zadania. Możesz dodać sekcje |
| 133 | +`prerequisites` i `whatsnext` do swojej strony za pomocą kodu `heading`. |
| 134 | + |
| 135 | +Każdą sekcję uzupełnij treścią. Użyj następujących wytycznych: |
| 136 | + |
| 137 | +- Użyj nagłówków poziomu H2 lub niższego (z dwoma wiodącymi |
| 138 | + znakami `#`). Sekcje są automatycznie tytułowane przez szablon. |
| 139 | +- Dla `overview` użyj akapitu, aby ustawić kontekst dla całego tematu. |
| 140 | +- Dla `prerequisites` używaj list punktowanych, kiedy to możliwe. Zaczynaj dodawać dodatkowe |
| 141 | + wymagania wstępne poniżej `include`. Domyślne wymagania wstępne obejmują działający klaster Kubernetes. |
| 142 | +- Dla `steps` używaj numerowanych list. |
| 143 | +- Do omówienia użyj standardowej treści, aby rozwinąć |
| 144 | + informacje zawarte w sekcji `steps`. |
| 145 | +- Dla `whatsnext`, podaj listę punktowaną z maksymalnie 5 tematami, |
| 146 | + które mogą zainteresować czytelnika jako kolejne tematy do przeczytania. |
| 147 | + |
| 148 | +Przykład opublikowanego tematu zadania to [Korzystanie z proxy HTTP do uzyskania dostępu do API Kubernetesa](/docs/tasks/extend-kubernetes/http-proxy-access-api/). |
| 149 | + |
| 150 | +### Samouczek (ang. Tutorial) {#tutorial} |
| 151 | + |
| 152 | +Strona samouczka pokazuje, jak osiągnąć cel, który jest bardziej złożony |
| 153 | +niż pojedyncze zadanie. Zazwyczaj strona samouczka składa się z kilku |
| 154 | +sekcji, z których każda zawiera sekwencję kroków. Na przykład samouczek może |
| 155 | +przeprowadzać użytkownika przez przykładowy kod ilustrujący określoną |
| 156 | +funkcję Kubernetesa. Samouczki mogą zawierać ogólne wyjaśnienia, ale powinny |
| 157 | +odsyłać do powiązanych tematów koncepcyjnych w celu dogłębnego omówienia zagadnienia. |
| 158 | + |
| 159 | +Aby napisać nową stronę samouczka, utwórz plik Markdown w |
| 160 | +podkatalogu katalogu `/content/en/docs/tutorials`, z następującymi sekcjami: |
| 161 | + |
| 162 | +| Sekcja strony | |
| 163 | +|------------------------------| |
| 164 | +| overview - przegląd | |
| 165 | +| prerequisites - wymagania wstępne | |
| 166 | +| objectives - cele | |
| 167 | +| lessoncontent - treść lekcji | |
| 168 | +| cleanup - sprzątanie | |
| 169 | +| whatsnext - co dalej | |
| 170 | + |
| 171 | +Sekcje `overview`, `objectives` i `lessoncontent` pojawiają się |
| 172 | +jako komentarze na stronie samouczka. Możesz dodać sekcje |
| 173 | +`prerequisites`, `cleanup` i `whatsnext` do swojej strony za pomocą kodu `heading`. |
| 174 | + |
| 175 | +Każdą sekcję uzupełnij treścią. Użyj następujących wytycznych: |
| 176 | + |
| 177 | +- Użyj nagłówków poziomu H2 lub niższego (z dwoma wiodącymi |
| 178 | + znakami `#`). Sekcje są automatycznie tytułowane przez szablon. |
| 179 | +- Dla `overview` użyj akapitu, aby ustawić kontekst dla całego tematu. |
| 180 | +- W przypadku `prerequisites` używaj, jeśli to możliwe, list |
| 181 | + punktowanych. Dodaj dodatkowe wymagania wstępne poniżej tych domyślnie uwzględnionych. |
| 182 | +- Dla `objectives`, używaj list wypunktowanych. |
| 183 | +- Dla `lessoncontent`, użyj mieszanki list |
| 184 | + numerowanych i treści narracyjnej w zależności od potrzeb. |
| 185 | +- W przypadku `cleanup`, użyj numerowanych list, aby opisać |
| 186 | + kroki niezbędne do posprzątania stanu klastra po zakończeniu zadania. |
| 187 | +- Dla `whatsnext`, podaj listę punktowaną z maksymalnie 5 tematami, |
| 188 | + które mogą zainteresować czytelnika jako kolejne tematy do przeczytania. |
| 189 | + |
| 190 | +Przykładem opublikowanego tematu samouczka jest |
| 191 | +[Uruchamianie aplikacji bezstanowej przy użyciu Deployment](/docs/tasks/run-application/run-stateless-application-deployment/). |
| 192 | + |
| 193 | +### Materiały źródłowe (ang. Reference) {#reference} |
| 194 | + |
| 195 | +Każde narzędzie Kubernetesa ma swoją stronę materiałów źródłowych (ang. reference page), gdzie można znaleźć jego opis i |
| 196 | +listę dostępnych opcji. Dokumentacja ta jest generowana przez skrypty, które automatycznie pobierają informacje z poleceń narzędzia. |
| 197 | + |
| 198 | +Strona z odniesieniem do narzędzia ma kilka możliwych sekcji: |
| 199 | + |
| 200 | +| Sekcja strony | |
| 201 | +|------------------------------| |
| 202 | +| streszczenie | |
| 203 | +| opcje | |
| 204 | +| opcje z nadrzędnych poleceń | |
| 205 | +| przykłady | |
| 206 | +| zobacz także | |
| 207 | + |
| 208 | +Przykłady opublikowanych stron referencyjnych narzędzi to: |
| 209 | + |
| 210 | +- [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) |
| 211 | +- [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) |
| 212 | +- [kubectl](/docs/reference/kubectl/kubectl/) |
| 213 | + |
| 214 | +## {{% heading "whatsnext" %}} |
| 215 | + |
| 216 | +- Dowiedz się więcej o [Przewodniku stylu](/docs/contribute/style/style-guide/) |
| 217 | +- Dowiedz się więcej o [Przewodniku treści](/docs/contribute/style/content-guide/) |
| 218 | +- Dowiedz się więcej o [organizacji treści](/docs/contribute/style/content-organization/) |
0 commit comments