Przewodnik treści

Ta strona zawiera wytyczne dotyczące dokumentacji Kubernetesa.

Jeśli masz pytania dotyczące tego, co jest dozwolone, dołącz do kanału #sig-docs w Kubernetes Slack i zapytaj!

Możesz zarejestrować się na Kubernetes Slack pod adresem https://slack.k8s.io/.

Aby uzyskać informacje na temat tworzenia nowych treści do dokumentacji Kubernetesa, postępuj zgodnie z przewodnikiem stylu.

Przegląd

Źródło dla strony internetowej Kubernetesa, w tym dokumentacji, znajduje się w repozytorium kubernetes/website.

Znajdująca się w folderze kubernetes/website/content/<language_code>/docs, większość dokumentacji Kubernetesa jest specyficzna dla projektu Kubernetes.

Co jest dozwolone

Dokumentacja Kubernetesa akceptuje materiały o projektach firm trzecich tylko pod warunkiem, że:

• Zawartość dokumentuje oprogramowanie w projekcie Kubernetes
• Zawartość dokumentuje oprogramowanie, które znajduje się poza projektem, ale jest niezbędne do działania Kubernetesa.
• Treści są kanoniczne na kubernetes.io lub odsyłają do kanonicznych treści w innym miejscu

Treści firm trzecich

Dokumentacja Kubernetesa zawiera zastosowane przykłady projektów w projekcie Kubernetes—projektów znajdujących się w organizacjach GitHub kubernetes i kubernetes-sigs.

Linki do aktywnej zawartości w projekcie Kubernetes są zawsze dozwolone.

Kubernetes wymaga pewnych zewnętrznych treści, aby działać. Przykłady obejmują środowiska uruchomieniowe kontenerów (containerd, CRI-O, Docker), zasady sieciowe (wtyczki CNI), kontrolery Ingress oraz logowanie.

Dokumentacja może odnosić się do zewnętrznego oprogramowania open source (OSS) spoza projektu Kubernetesa tylko wtedy, gdy jest to niezbędne do działania Kubernetes.

Zduplikowane treści

W miarę możliwości dokumentacja Kubernetesa odsyła do kanonicznych źródeł zamiast hostować zduplikowaną treść.

Zduplikowana treść wymaga podwójnego wysiłku (lub więcej!) do utrzymania i szybciej staje się nieaktualna.

Więcej informacji

Jeśli masz pytania dotyczące dozwolonej treści, dołącz do kanału Kubernetes Slack #sig-docs i zapytaj!

Co dalej?

• Przeczytaj Przewodnik stylu.