To wielostronicowy widok tej sekcji do wydrukowania. Kliknij aby wydrukować.

Wróć do zwykłego widoku tej strony.

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.

flowchart TB subgraph third[Otwórz PR] direction TB U[ ] -.- Q[Ulepsz zawartość] --- N[Dodaj nową] N --- O[Przetłumacz dokumentację] O --- P[Zarządzaj dokumentacją
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
Schemat 1. - Jak rozpocząć współpracę

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ć.

flowchart LR subgraph second[Pierwszy wkład] direction TB S[ ] -.- G[Obejrzyj PR-y
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
Schemat 2. - Jak się przygotować

Co dalej?

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:

Inne sposoby współpracy

1 - Tłumaczenie dokumentacji na język polski

Na tej stronie znajdziesz wskazówki i wytyczne przydatne przy tłumaczeniu dokumentacji Kubernetesa na język polski.

Dokumentem nadrzędnym jest angielski opis stylu dokumentacji.

Wskazówki ogólne

Staramy się, aby styl tłumaczenia był jak najbardziej naturalny. W przypadku dokumentacji technicznej może być to trudne zadanie, szczególnie gdy chcemy utrzymać precyzję tłumaczenia. Zależy nam na unikaniu sytuacji, kiedy tekst zaczyna sprawiać wrażenie przetłumaczonego maszynowo.

Pamiętajmy też, że oficjalna wykładnia zawsze znajduje się w tekście angielskim. Polskie tłumaczenie ma ułatwić pierwsze kroki osobom, które zaczynają swoją przygodę z Kubernetesem.

Wytyczne szczegółowe

Odmiana terminu Kubernetes

Kubernetes jest nazwą własną, liczba pojedyncza, rodzaj męski. Odmieniamy: Kubernetesa, Kubernetesem itp. W uzasadnionych przypadkach można stosować też "system Kubernetes".

Odmiana terminów Pod, Deployment

Odmieniamy zgodnie z ogólnymi zasadami - poda, deploymentu itp.

Ujednolicony słownik

W sieci dostępne są słowniki terminów informatycznych. Poniższa tabela zawiera słowa specyficzne dla Kubernetesa i inne często używane wyrażenia.

Termin angielskiTłumaczenie
containerkontener
control planewarstwa sterowania
DeploymentDeployment
horizontal scalingskalowanie horyzontalne
PodPod
rolling updateaktualizacje stopniowe
volumevolume (opcjonalnie: wolumin)
worker nodewęzeł roboczy