Współtworzenie dokumentacji Kubernetes

Ta strona jest utrzymywana przez Kubernetes SIG Docs. Projekt Kubernetes chętnie przyjmie pomoc od wszystkich współtwórców, zarówno nowych, jak i doświadczonych!

Współtwórcy dokumentacji Kubernetesa:

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

Zespół blogowy, będący częścią SIG Docs, pomaga zarządzać oficjalnymi blogami. Aby dowiedzieć się więcej, przeczytaj jak współtworzyć blogi Kubernetesa.

---

Rozpoczęcie pracy

Każdy może otworzyć zgłoszenie dotyczące dokumentacji lub wnieść zmianę za pomocą pull request (PR) w repozytorium kubernetes/website na GitHubie. Musisz umieć sprawnie korzystać z git i GitHub, aby efektywnie pracować w społeczności Kubernetesa.

Aby zaangażować się w tworzenie dokumentacji:

1. Podpisz umowę licencyjną współtwórcy CNCF.
2. Zapoznaj się z repozytorium dokumentacji oraz generatorem statycznych stron witryny.
3. Upewnij się, że rozumiesz podstawowe procesy otwierania pull requesta i przeglądania zmian.

flowchart TB
subgraph third[Otwórz PR]
direction TB
U[ ] -.-
Q[Popraw treść] --- N[Utwórz treść]
N --- O[Tłumacz dokumentację]
O --- P[Zarządzaj/publikuj części dokumentów
w cyklu wydania K8s]

end

subgraph second[Przegląd]
direction TB
   T[ ] -.-
   D[Przejrzyj repozytorium
kubernetes/website] --- E[Sprawdź generator
stron statycznych Hugo]
   E --- F[Zrozum podstawowe
komendy GitHub]
   F --- G[Przejrzyj otwarte PR
i procesy przeglądu zmian]
end

subgraph first[Rejestracja]
    direction TB
    S[ ] -.-
    B[Podpisz umowę o
licencję wniesienia
wkładu CNCF] --- C[Dołącz do kanału
Slack sig-docs]
    C --- V[Dołącz do listy
mailowej kubernetes-sig-docs]
    V --- M[Uczestnicz w cotygodniowych
spotkaniach sig-docs
lub spotkaniach na Slacku]
end

A([fa:fa-user Nowy
Współtwórca]) --> first
A --> second
A --> third
A --> H[Pytaj!!!]


classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey
class S,T,U spacewhite
class first,second,third white

Rysunek 1. Jak zacząć jako nowy współtwórca.

Rysunek 1 przedstawia plan działania dla nowych współtwórców. Możesz podążać za niektórymi lub wszystkimi krokami dotyczącymi Sign up i Review. Teraz możesz otwierać PR spełniające Twoje cele kontrybucji - niektóre z nich znajdziesz w sekcji Open PR. Jak zawsze, pytania są mile widziane!

Niektóre zadania wymagają większego zaufania i większego dostępu w organizacji Kubernetes. Zobacz Udział w SIG Docs po więcej szczegółów na temat ról i uprawnień.

Twoja pierwsza kontrybucja

Aby przygotować się do twojej pierwszej kontrybucji, warto wcześniej przeanalizować kilka kroków. Rysunek 2 przedstawia ich schemat, a szczegółowe informacje znajdują się poniżej.

flowchart LR
    subgraph second[Pierwszy wkład]
    direction TB
    S[ ] -.-
    G[Przeglądaj PR od innych
członków K8s] -->
    A[Sprawdź listę zgłoszeń
kubernetes/website
dobre na pierwszy PR] --> B[Otwórz PR!!]
    end
    subgraph first[Zalecane przygotowanie]
    direction TB
       T[ ] -.-
       D[Przeczytaj współtworzenie nowych treści] -->E[Przeczytaj przewodniki
po treści K8s i stylach]
       E --> F[Poznaj typy treści
stron Hugo
i shortcode'y]
    end
    

    first ----> second
     

classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,D,E,F,G grey
class S,T spacewhite
class first,second white

Rysunek 2. Przygotowanie do twojej pierwszej kontrybucji.

• Przeczytaj Współtworzenie nowych treści, aby dowiedzieć się o różnych sposobach, w jakie możesz wnieść wkład.
• Sprawdź listę problemów kubernetes/website, aby znaleźć problemy, które są dobrymi punktami wyjścia.
• Otwórz pull request używając GitHub do istniejącej dokumentacji i dowiedz się więcej o zgłaszaniu problemów na GitHub.
• Przeglądaj pull requesty od innych członków społeczności Kubernetesa pod kątem dokładności i języka.
• Przeczytaj przewodnik treści i przewodniki stylu dla Kubernetesa, aby móc zostawiać merytoryczne komentarze.
• Dowiedz się więcej o typach treści stron i shortcode`ach Hugo.

Uzyskiwanie pomocy przy współtworzeniu

Rozpoczęcie współpracy nad projektem może być wyzwaniem. Ambasadorzy Nowych Współtwórców pomogą Ci przejść przez pierwsze kroki. Możesz skontaktować się z nimi na Kubernetes Slack, najlepiej na kanale #sig-docs. Istnieje również rozmowa powitalna dla nowych współtwórców, która odbywa się w pierwszy wtorek każdego miesiąca. Możesz tu wchodzić w interakcje z Ambasadorami Nowych Współtwórców i uzyskać odpowiedzi na swoje pytania.

Zaangażuj się w SIG Docs.

SIG Docs to grupa współtwórców, którzy publikują i utrzymują dokumentację Kubernetesa oraz stronę internetową. Zaangażowanie się w SIG Docs to doskonały sposób dla współtwórców Kubernetes (rozwój funkcji lub inne) na wywarcie dużego wpływu na projekt Kubernetesa.

SIG Dokumentacja komunikuje się za pomocą różnych metod:

• Dołącz do #sig-docs na Slacku Kubernetes. I nie zapomnij się przedstawić!
• Dołącz do listy mailingowej kubernetes-sig-docs, gdzie odbywają się szersze dyskusje i zapisywane są oficjalne decyzje.
• Dołącz do spotkania wideo SIG Docs odbywającego się co dwa tygodnie. Spotkania są zawsze ogłaszane na #sig-docs i dodawane do kalendarza spotkań społeczności Kubernetes. Będziesz musiał pobrać klienta Zoom lub zadzwonić z telefonu.
• Dołącz do asynchronicznego spotkania SIG Docs na Slacku w tygodniach, kiedy spotkanie wideo na Zoomie na żywo się nie odbywa. Spotkania są zawsze ogłaszane na #sig-docs. Możesz wnieść swój wkład w dowolny z wątków do 24 godzin po ogłoszeniu spotkania.

Inne sposoby wnoszenia wkładu

• Odwiedź stronę społeczności Kubernetesa. Skorzystaj z Twittera lub Stack Overflow, dowiedz się o lokalnych spotkaniach i wydarzeniach Kubernetesa i nie tylko.
• Przeczytaj ściągawkę współtwórcy, aby zaangażować się w rozwój funkcji Kubernetesa.
• Odwiedź stronę dla współtwórców, aby dowiedzieć się więcej o współtwórcach Kubernetesa oraz dodatkowych zasobach dla współtwórców.
• Dowiedz się, jak współtworzyć oficjalne blogi
• Prześlij studium przypadku

Następne kroki.

• Naucz się pracować z lokalną kopią repozytorium.

• Zredaguj funkcje w wydaniu.

• Weź udział w SIG Docs i zostań członkiem lub recenzentem.

• Rozpocznij lub pomóż w lokalizacji.