Weź udział w tworzeniu dokumentacji Kubernetesa

Edit This Page

Weź udział w tworzeniu dokumentacji Kubernetesa

Będzie nam bardzo miło, jeśli zechcesz wziąć udział w tworzeniu dokumentacji lub strony www Kubernetesa! Nieważne, czy dopiero poznajesz projekt, czy jesteś z nami już od dawna, czy uważasz się za programistę, użytkownika, czy po prostu nie możesz patrzeć na literówki.

Więcej informacji na temat zawartości dokumentacji Kubernetesa i jej stylu, znajdziesz w Opisie stylu dokumentacji.

Rodzaje uczestnictwa w procesie tworzenia dokumentacji

  • Członek (member) organizacji Kubernetes, który podpisał CLA i poświęcił swój czas oraz wysiłek na rzecz projektu. Dokument Członkostwo w organizacji zawiera szczegóły z tym związane.
  • Recenzent (reviewer) SIG Docs to członek organizacji Kubernetes, który zgłosił swoją chęć weryfikacji propozycji zmian w dokumentacji (PR) i został dodany do odpowiedniej grupy GitHub i pliku ‘OWNERS’ w repozytorium GitHub przez osobę zatwierdzającą SIG Docs.
  • Osoba zatwierdzająca (approver) SIG Docs to członek organizacji o uznanej reputacji, który wykazał się długotrwałym zaangażowaniem w prace projektu. Osoba zatwierdzająca może włączać propozycje zmian do repozytoriów i publikować treści w imieniu organizacji Kubernetes. Osoby zatwierdzające mogą również reprezentować SIG Docs na szerszym forum społeczności Kubernetes. Niektóre wymagania związane z tą rolą, jak na przykład koordynacja kolejnego wydania, wymagają poświęcenia znacznej ilości czasu.

Sposoby współpracy przy tworzeniu dokumentacji

Poniższa lista podzielona jest na rzeczy, które może robić każdy, te, które może robić członek organizacji Kubernetes oraz na takie, które wymagają wyższych uprawnień i znajomości procesów SIG Docs. W miarę postępującej współpracy, będziesz mógł lepiej zrozumieć niektóre narzędzia czy decyzje, które zostały wcześniej podjęte na poziomie organizacyjnym.

Ta lista nie wyczerpuje wszystkich możliwości udziału, ale powinna być pomocna na początku.

  • Każdy
    • Otwieranie wszelkiego rodzaju zgłoszeń, względem których mogą zostać podjęte jakieś działania
  • Członek
    • Ulepszanie istniejącej dokumentacji
    • Zgłaszanie pomysłów na ulepszenia poprzez komunikator Slack lub listę dystrybucyjną SIG docs
    • Zwiększanie dostępności dokumentacji
    • Zgłaszanie niewiążących uwag do propozycji zmian (PR)
    • Pisanie bloga lub studium przypadku
  • Recenzent
    • Opisywanie nowych funkcjonalności
    • Przydzielanie kategorii i klasyfikowanie zgłoszeń
    • Recenzowanie propozycji zmian
    • Tworzenie schematów, grafik, osadzonych prezentacji (screencasts) i filmów
    • Tłumaczenie
    • Współtworzenie zawartości innych repozytoriów jako przedstawiciel zespołu dokumentacji
    • Opracowywanie osadzonych w oprogramowaniu komunikatów dla użytkownika
    • Ulepszanie komentarzy w oprogramowaniu, Godoc
  • Osoba zatwierdzająca
    • Publikowanie dostarczonych treści poprzez zatwierdzanie propozycji zmian i włączanie ich do repozytorium
    • Udział w pracach zespołu przygotowującego nowe wydanie Kubernetesa jako przedstawiciel zespołu dokumentacji
    • Proponowanie ulepszeń wytycznych dotyczących stylu
    • Proponowanie ulepszeń testowania dokumentacji
    • Proponowanie ulepszeń strony Kubernetes lub innych narzędzi

Inne metody współpracy

  • Aby włączyć się w prace społeczności Kubernetes poprzez fora internetowe, typu Twitter czy Stack Overflow, lub dowiedzieć się więcej na temat organizowanych lokalnie spotkań i wydarzeń związanym z projektem, zajrzyj na stronę społeczności Kubernetes.
  • Aby włączyć się w prace związane z nowymi funkcjonalnościami, przeczytaj na początek ściągawkę dla współautorów.

Twoja opinia