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:
- Podpisać Contributor License Agreement CNCF.
- Zapoznać się z repozytorium dokumentacji i z generatorem statycznej strony www.
- Zrozumieć podstawowe procesy otwierania pull request oraz recenzowania zmian.
przy kolejnych
wydaniach K8s]
end
subgraph second[Recenzuj]
direction TB
T[ ] -.-
D[Przejrzyj
repozytorium
K8s/website] --- E[Pobierz generator
stron statycznych
Hugo]
E --- F[Zrozum podstawowe
polecenia GitHub-a]
F --- G[Zrecenzuj otwarty PR
i zmień procesy
recenzji]
end
subgraph first[Zapisz się]
direction TB
S[ ] -.-
B[Podpisz CNCF
Contributor
License Agreement] --- C[Dołącz do Slack-a
sig-docs]
C --- V[Zapisz się na listę
kubernetes-sig-docs]
V --- M[Weź udział w cotygodniowych
spotkaniach sig-docs]
end
A([fa:fa-user Nowy
uczestnik]) --> first
A --> second
A --> third
A --> H[Zapytaj!!!]
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
To jest schemat postępowania 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 poniżej, aby się lepiej przygotować.
innych uczestników K8s] -->
A[Przejrzyj listę zgłoszonych spraw
na K8s/website
po pomysł na nowy PR] --> B[Otwórz PR!!]
end
subgraph first[Sugerowane przygotowanie]
direction TB
T[ ] -.-
D[Przeczytaj wprowadzenie
dla współtwórców] -->E[Przeczytaj K8s content
and style guides]
E --> F[Poczytaj o typach zawartości
stron i skrótach Hugo]
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
- 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-docsna 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-docsi 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.