Współtwórz dokumentację K8s

Kubernetes zaprasza do współpracy wszystkich - zarówno nowicjuszy, jak i doświadczonych!

Tym serwisem www opiekuje się Kubernetes SIG Docs.

Współtwórcy dokumentacji Kubernetesa:

• Ulepszają istniejącą zawartość
• Tworzą nowe treści
• Tłumaczą dokumentację
• Zarządzają i publikują dokumentację w ramach cyklu wydawniczego Kubernetesa

Jak zacząć?

Każdy może otworzyć zgłoszenie dotyczące dokumentacji lub zaproponować zmianę poprzez pull request (PR) do repozytorium GitHub kubernetes/website. Aby móc sprawnie funkcjonować w społeczności Kubernetes, wymagana jest pewna biegłość w korzystaniu z git-a i GitHub-a.

Aby zaangażować się w prace nad dokumentacją należy:

1. Podpisać Contributor License Agreement CNCF.
2. Zapoznać się z repozytorium dokumentacji i z generatorem statycznej strony www.
3. Zrozumieć podstawowe procesy otwierania pull request oraz recenzowania zmian.

Schemat 1 przeznaczony jest dla osób, które chcą zacząć współtworzyć Kubernetesa. Przejdź część lub wszystkie kroki opisane w częściach Zapisz się i Recenzuj. Teraz już możesz tworzyć nowe PR, zgodnie z sugestiami w Otwórz PR. I jak zawsze, pytania mile widziane!

Do realizacji niektórych zadań potrzeba wyższego poziomu zaufania i odpowiednich uprawnień w organizacji Kubernetes. Zajrzyj do Participating in SIG Docs po więcej szczegółów dotyczących ról i uprawnień.

Pierwsze kroki

Zapoznaj się z krokami opisanymi na schemacie 2, aby się lepiej przygotować.

• Przeczytaj Contribution overview, aby dowiedzieć się o różnych sposobach współpracy.
• Zajrzyj do Contribute to kubernetes/website, aby znaleźć dobre zgłoszenie na początek.
• Otwórz pull request przy pomocy GitHub-a dotyczący zmiany istniejącej dokumentacji i dowiedz się, jak otwierać zgłoszenia przy GitHub-ie.
• Zrecenzuj pull requests innego członka społeczności Kubernetes pod kątem dokładności i stylu.
• Zapoznaj się z poradnikami Kubernetesa dotyczącymi zawartości i stylu, aby twoje uwagi były zgodne z tymi wytycznymi.
• Przeczytaj o różnych typach zawartości na stronie i skrótach Hugo.

Co dalej?

• Naucz się, jak pracować z lokalną kopią repozytorium.
• Udokumentuj nowe funkcjonalności.
• Włącz się w prace SIG Docs i zostań członkiem organizacji lub recenzentem.
• Pomagaj przy tłumaczeniu.

Włącz się w prace SIG Docs

SIG Docs to grupa, która publikuje i utrzymuje dokumentację Kubernetesa i jej stronę www. Zaangażowanie się w prace SIG Docs to doskonała okazja dla współtwórców Kubernetesa (rozwijających nowe funkcjonalności lub działających w innych obszarach), aby wywierać wpływ na cały projekt Kubernetes.

Aby włączyć się w komunikację w ramach SIG Docs, możesz:

• Dołączyć do kanału #sig-docs na komunikatorze Slack dla Kubernetesa. Nie zapomnij się przedstawić!
• Zapisać się na listę kubernetes-sig-docs, na której prowadzone są dyskusje o szerszym zasięgu i zapisywane oficjalne decyzje.
• Dołączyć do spotkania wideo SIG Docs odbywającego się co dwa tygodnie. Spotkania są zawsze zapowiadane na #sig-docs i dodawane do kalendarza spotkań społeczności Kubernetesa. Będziesz potrzebował komunikatora Zoom lub telefonu, aby się wdzwonić.
• Dołączyć do spotkania SIG Docs na Slacku organizowanego w tych tygodniach, kiedy nie ma spotkania na Zoomie. Informacja o spotkaniu zawsze ogłaszana jest na #sig-docs. W rozmowach prowadzonych w różnych wątkach na tym kanale można brać udział do 24 godzin od chwili ogłoszenia.

Inne sposoby współpracy

• Odwiedź stronę społeczności Kubernetesa. Korzystaj z Twittera i Stack Overflow, dowiedz się o spotkaniach lokalnych grup Kubernetesa, różnych wydarzeniach i nie tylko.
• Przeczytaj ściągawkę dla współtwórców, aby zaangażować się w dalszy rozwój Kubernetesa.
• Odwiedź stronę Kubernetes Contributors i zajrzyj do dodatkowych zasobów.
• Przygotuj wpis na blogu lub case study.