|
| 1 | +--- |
| 2 | +title: Dokumentowanie funkcji nowego wydania |
| 3 | +linktitle: Dokumentowanie nowego wydania |
| 4 | +content_type: concept |
| 5 | +main_menu: true |
| 6 | +weight: 20 |
| 7 | +card: |
| 8 | + name: contribute |
| 9 | + weight: 45 |
| 10 | + title: Dokumentowanie funkcji nowego wydania |
| 11 | +--- |
| 12 | +<!-- overview --> |
| 13 | + |
| 14 | +Każda główna wersja Kubernetesa wprowadza nowe funkcje, które wymagają |
| 15 | +dokumentacji. Nowe wersje przynoszą również aktualizacje do istniejących |
| 16 | +funkcji i dokumentacji (na przykład awansowanie funkcji z wersji alpha do beta). |
| 17 | + |
| 18 | +Zazwyczaj SIG odpowiedzialny za funkcję przesyła szkic dokumentacji |
| 19 | +funkcji jako pull request do odpowiedniego gałęzi rozwojowej w repozytorium |
| 20 | +`kubernetes/website`, a ktoś z zespołu SIG Docs dostarcza uwagi redakcyjne |
| 21 | +lub edytuje szkic bezpośrednio. Ta sekcja opisuje konwencje dotyczące |
| 22 | +rozgałęzień (ang. branching) oraz proces stosowany podczas wydania przez obie grupy. |
| 23 | + |
| 24 | +<!-- body --> |
| 25 | + |
| 26 | +## Dla współtwórców dokumentacji {#for-documentation-contributors} |
| 27 | + |
| 28 | +Ogólnie rzecz biorąc, współtwórcy dokumentacji nie piszą treści od |
| 29 | +podstaw na potrzeby wydania. Zamiast tego współpracują z SIG tworzącym |
| 30 | +nową funkcję, aby dopracować szkic dokumentacji i przygotować go do wydania. |
| 31 | + |
| 32 | +Po wybraniu fukncji do udokumentowania lub wsparcia, zapytaj o nią na kanale |
| 33 | +Slack `#sig-docs`, podczas cotygodniowego spotkania SIG Docs lub bezpośrednio w |
| 34 | +zgłoszeniu PR wystawionym przez SIG odpowiedzialny za funkcje. Jeśli otrzymasz |
| 35 | +zgodę, możesz edytować PR za pomocą jednej z technik opisanych w |
| 36 | +[Wprowadź zmiany do PR innej osoby](/docs/contribute/review/for-approvers/#commit-into-another-person-s-pr). |
| 37 | + |
| 38 | +### Dowiedz się o nadchodzących funkcjach {#find-out-about-upcoming-features} |
| 39 | + |
| 40 | +Aby dowiedzieć się o nadchodzących funkcjach, weź udział w |
| 41 | +cotygodniowym spotkaniu SIG Release (zobacz stronę [społeczności](/community/) w |
| 42 | +celu uzyskania informacji o nadchodzących spotkaniach) i monitoruj |
| 43 | +dokumentację dotyczącą wydania w repozytorium |
| 44 | +[kubernetes/sig-release](https://github.com/kubernetes/sig-release/). Każde wydanie ma podkatalog w |
| 45 | +katalogu [/sig-release/tree/master/releases/](https://github.com/kubernetes/sig-release/tree/master/releases). |
| 46 | +Podkatalog zawiera harmonogram |
| 47 | +wydania, szkic notatek do wydania oraz dokument z listą każdej osoby w zespole wydania. |
| 48 | + |
| 49 | +Harmonogram wersji zawiera linki do wszystkich innych dokumentów, spotkań, |
| 50 | +protokołów spotkań i kamieni milowych związanych z |
| 51 | +wydaniem. Zawiera również informacje o celach i harmonogramie wydania oraz |
| 52 | +wszelkich specjalnych procesach wdrożonych dla tego |
| 53 | +wydania. Pod koniec dokumentu zdefiniowano kilka terminów związanych z wydaniem. |
| 54 | + |
| 55 | +Ten dokument zawiera również link do |
| 56 | +**Arkusza śledzenia funkcji**, który jest oficjalnym sposobem na poznanie |
| 57 | +wszystkich nowych funkcji planowanych do wprowadzenia w wydaniu. |
| 58 | + |
| 59 | +Dokumentacja zespołu odpowiadającego za kolejne wydanie zawiera listę osób do przypisanych do |
| 60 | +różnych ról. Jeśli nie jest jasne, do kogo się zwrócić w sprawie konkretnej funkcji lub |
| 61 | +pytania, które masz, możesz skorzystać z jednego z dwóch rozwiązań: weź udział w spotkaniu zespołu, |
| 62 | +aby zadać swoje pytanie, lub skontaktuj się z liderem wydania, aby mógł Cię odpowiednio skierować. |
| 63 | + |
| 64 | +Szkic notatek z wydania to dobre miejsce, aby dowiedzieć się o specyficznych |
| 65 | +funkcjach, zmianach, przestarzałych elementach i innych kwestiach dotyczących |
| 66 | +wydania. Ponieważ treść nie jest ostateczna aż do późnego etapu, warto zachować ostrożność. |
| 67 | + |
| 68 | +### Arkusz śledzenia funkcji {#feature-tracking-sheet} |
| 69 | + |
| 70 | +Arkusz śledzenia funkcji [dla danej wersji Kubernetesa](https://github.com/kubernetes/sig-release/tree/master/releases) |
| 71 | +wymienia |
| 72 | +każdą funkcję, która jest planowana do wydania. Każdy element zawiera nazwę |
| 73 | +funkcji, link do głównego problemu na GitHubie, poziom |
| 74 | +stabilności (Alpha, Beta lub Stable), SIG i osobę odpowiedzialną za |
| 75 | +jej wdrożenie, czy wymaga dokumentacji, projekt notatki o wydaniu |
| 76 | +dla funkcji oraz czy została zintegrowana. Pamiętaj o następujących zasadach: |
| 77 | + |
| 78 | +- Funkcje w wersji Beta i Stable są zazwyczaj |
| 79 | + priorytetowane wyżej w dokumentacji niż funkcje w wersji Alfa. |
| 80 | +- Trudno jest przetestować (a tym samym udokumentować) funkcję, która nie została |
| 81 | + zmergowana, lub przynajmniej jest uważana za kompletną w swoim PR. |
| 82 | +- Określenie, czy funkcja wymaga dokumentacji, jest procesem manualnym. Nawet jeśli |
| 83 | + funkcja nie jest oznaczona jako wymagająca dokumentacji, może być konieczne jej udokumentowanie. |
| 84 | + |
| 85 | +## Dla developerów lub innych członków SIG {#for-developers-or-other-sig-members} |
| 86 | + |
| 87 | +Ta sekcja zawiera informacje dla członków innych SIG |
| 88 | +Kubernetesów dokumentujących nowe funkcje na potrzeby wydania. |
| 89 | + |
| 90 | +Jeśli jesteś członkiem SIG, który rozwija nową funkcję dla |
| 91 | +Kubernetesa, musisz współpracować z SIG Docs, aby mieć pewność, że |
| 92 | +Twoja funkcja zostanie udokumentowana na czas przed wydaniem. |
| 93 | +Sprawdź [arkusz śledzenia funkcji](https://github.com/kubernetes/sig-release/tree/master/releases) |
| 94 | +lub sprawdź kanał Slack |
| 95 | +Kubernetes `#sig-release`, aby zweryfikować szczegóły harmonogramu i terminy. |
| 96 | + |
| 97 | +### Otwórz tymczasowy PR {#open-a-placeholder-pr} |
| 98 | + |
| 99 | +1. Otwórz **szkic** pull requestu do gałęzi |
| 100 | + `dev-{{< skew nextMinorVersion >}}` w repozytorium `kubernetes/website`, z małym |
| 101 | + commitem, który później zmienisz. Aby utworzyć szkic pull |
| 102 | + requestu, użyj rozwijanego menu **Create Pull Request** i wybierz |
| 103 | + **Create Draft Pull Request**, następnie kliknij **Draft Pull Request**. |
| 104 | +1. Edytuj opis pull requesta, aby zawierał linki do PR-ów w |
| 105 | + [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) oraz zgłoszeń w [kubernetes/enhancements](https://github.com/kubernetes/enhancements). |
| 106 | +1. Zostaw komentarz w powiązanym zgłoszeniu w tym repozytorium |
| 107 | + [kubernetes/enhancements](https://github.com/kubernetes/enhancements) z linkiem do PR, aby powiadomić osobę zajmującą się dokumentacją |
| 108 | + tej wersji, że dokumentacja dotycząca funkcji jest w przygotowaniu i powinna być śledzona w tym wydaniu. |
| 109 | + |
| 110 | +Jeśli Twoja funkcjonalność nie wymaga żadnych zmian w dokumentacji, upewnij się, że zespół |
| 111 | +sig-release o tym wie, wspominając o tym na kanale Slack `#sig-release`. Jeśli funkcjonalność wymaga |
| 112 | +dokumentacji, ale PR nie został utworzony, funkcjonalność może zostać usunięta z kamienia milowego. |
| 113 | + |
| 114 | +### PR gotowy do przeglądu {#pr-ready-for-review} |
| 115 | + |
| 116 | +Kiedy będziesz gotowy, wypełnij swój tymczasowy PR dokumentacją funkcji i zmień |
| 117 | +stan PR z roboczego na **ready for review**. Aby oznaczyć pull request jako gotowy |
| 118 | +do przeglądu, przejdź do pola scalania (ang. merge box) i kliknij **Ready for review**. |
| 119 | + |
| 120 | +Najlepiej jak potrafisz opisz swoją funkcję i sposób jej użycia. Jeśli |
| 121 | +potrzebujesz pomocy w strukturyzacji swojej dokumentacji, zapytaj na kanale Slack `#sig-docs`. |
| 122 | + |
| 123 | +Gdy ukończysz swój materiał, osoba odpowiedzialna za dokumentację przypisana do Twojej funkcji go |
| 124 | +przegląda. Aby zapewnić dokładność techniczną, treść może również wymagać przeglądu technicznego |
| 125 | +przez odpowiednie SIG-i. Skorzystaj z ich sugestii, aby dopracować treść do stanu gotowego do wydania. |
| 126 | + |
| 127 | +Jeśli twoja funkcja wymaga dokumentacji, a pierwsza wersja treści nie zostanie |
| 128 | +dostarczona, funkcja może zostać usunięta z kamienia milowego. |
| 129 | + |
| 130 | +#### Bramki funkcji (ang. feature gates) {#ready-for-review-feature-gates} |
| 131 | + |
| 132 | +Jeśli Twoja funkcja jest funkcją Alfa lub Beta i jest włączana warunkowo |
| 133 | +bramką funkcji (ang. feature gate), potrzebujesz dla niej pliku bramki |
| 134 | +funkcji wewnątrz `content/en/docs/reference/command-line-tools-reference/feature-gates/`. |
| 135 | +Nazwa pliku powinna być nazwą bramki funkcji z sufiksem `.md`. |
| 136 | +Możesz spojrzeć na inne pliki już znajdujące się w tym samym katalogu, aby |
| 137 | +uzyskać wskazówkę, jak powinien wyglądać Twój plik. Zwykle wystarczy jeden |
| 138 | +akapit; dla dłuższych wyjaśnień dodaj dokumentację w innym miejscu i dodaj do niej link. |
| 139 | + |
| 140 | +Aby upewnić się, że twój feature gate pojawi się w tabeli |
| 141 | +[Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features), |
| 142 | +dodaj następujące |
| 143 | +informacje do sekcji |
| 144 | +[front matter](https://gohugo.io/content-management/front-matter/) w pliku Markdown z opisem: |
| 145 | + |
| 146 | +```yaml |
| 147 | +stages: |
| 148 | + - stage: <alpha/beta/stable/deprecated> # Specify the development stage of the feature gate |
| 149 | + defaultValue: <true or false> # Set to true if enabled by default, false otherwise |
| 150 | + fromVersion: <Version> # Version from which the feature gate is available |
| 151 | + toVersion: <Version> # (Optional) The version until which the feature gate is available |
| 152 | +``` |
| 153 | +
|
| 154 | +W przypadku nowych bramek funkcji wymagany jest również osobny opis |
| 155 | +bramki funkcji; utwórz nowy plik Markdown w |
| 156 | +`content/en/docs/reference/command-line-tools-reference/feature-gates/` (użyj innych plików jako szablonu). |
| 157 | + |
| 158 | +Gdy zmieniasz bramkę funkcji z domyślnie wyłączonej na domyślnie włączoną, |
| 159 | +może być konieczne zmienienie również innej |
| 160 | +dokumentacji (nie tylko listy bramek funkcji). Uważaj na zwroty takie jak „Pole |
| 161 | +`exampleSetting` jest polem beta i jest domyślnie |
| 162 | +wyłączone. Możesz je włączyć, włączając bramkę funkcji `ProcessExampleThings`.” |
| 163 | + |
| 164 | +Jeśli Twoja funkcja osiągnęła status GA lub została oznaczona jako |
| 165 | +przestarzała, dodaj dodatkowy wpis `stage` w ramach bloku `stages` w pliku opisu. Upewnij się, |
| 166 | +że etapy Alpha i Beta pozostają nienaruszone. Ten krok przenosi bramkę |
| 167 | +funkcji z [Feature gates for Alpha/Beta](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) |
| 168 | +do |
| 169 | +[Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features). |
| 170 | +Na przykład: |
| 171 | + |
| 172 | +{{< highlight yaml "linenos=false,hl_lines=10-17" >}} |
| 173 | +stages: |
| 174 | + - stage: alpha |
| 175 | + defaultValue: false |
| 176 | + fromVersion: "1.12" |
| 177 | + toVersion: "1.12" |
| 178 | + - stage: beta |
| 179 | + defaultValue: true |
| 180 | + fromVersion: "1.13" |
| 181 | + # Added a `toVersion` to the previous stage. |
| 182 | + toVersion: "1.18" |
| 183 | + # Added 'stable' stage block to existing stages. |
| 184 | + - stage: stable |
| 185 | + defaultValue: true |
| 186 | + fromVersion: "1.19" |
| 187 | + toVersion: "1.27" |
| 188 | +{{< / highlight >}} |
| 189 | + |
| 190 | +Ostatecznie Kubernetes przestanie w ogóle uwzględniać bramę funkcji. |
| 191 | +Aby zasygnalizować usunięcie bramy funkcji, uwzględnij `removed: true` w |
| 192 | +przedniej części odpowiedniego pliku opisu. Wprowadzenie tej zmiany |
| 193 | +oznacza, że informacje o bramie funkcji przenoszą się z |
| 194 | +[Skróty funkcji dla ukończonych lub przestarzałych funkcji](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed) do dedykowanej |
| 195 | +strony |
| 196 | +zatytułowanej [Skróty funkcji (usunięte)](/docs/reference/command-line-tools-reference/feature-gates-removed/), |
| 197 | +łącznie z jej opisem. |
| 198 | + |
| 199 | +### Wszystkie PR-y zostały zrecenzowane i są gotowe do scalenia {#all-prs-reviewed-and-ready-to-merge} |
| 200 | + |
| 201 | +Jeśli Twój PR nie został jeszcze scalony z gałęzią `dev-{{< skew nextMinorVersion >}}` |
| 202 | +przed terminem wydania, współpracuj z osobą odpowiedzialną za dokumentację i zarządzającą wydaniem, |
| 203 | +aby dodać go przed terminem. Jeśli Twoja funkcja potrzebuje dokumentacji, a |
| 204 | +dokumentacja nie jest gotowa, funkcja może zostać usunięta z bieżącego planu (**milestone**). |
0 commit comments