Посібник з вмісту документації

Ця сторінка містить настанови щодо документації Kubernetes.

Якщо у вас є запитання щодо того, що дозволено, приєднайтеся до каналу #sig-docs у Kubernetes Slack і запитайте!

Ви можете зареєструватися на Kubernetes Slack за адресою https://slack.k8s.io/.

Інформацію про створення нового вмісту для документації Kubernetes див. у посібнику зі стилю.

Огляд

Вихідний код вебсайту Kubernetes, зокрема документації, розміщено в репозиторії kubernetes/website.

Більшість документації Kubernetes розташована в теці kubernetes/website/content/<language_code>/docs і стосується саме проєкту Kubernetes.

Що дозволено

Документація Kubernetes допускає вміст для сторонніх проєктів лише тоді, коли:

• Вміст документує програмне забезпечення в проєкті Kubernetes
• Вміст документує програмне забезпечення поза проєктом, яке потрібне для роботи Kubernetes
• Вміст є канонічним на kubernetes.io або посилається на канонічний вміст в іншому місці

Сторонній вміст

Документація Kubernetes містить прикладні приклади проєктів, що входять до проєкту Kubernetes, — проєктів, розміщених в організаціях GitHub kubernetes і kubernetes-sigs.

Посилання на активний вміст у проєкті Kubernetes завжди дозволені.

Для роботи Kubernetes потрібен деякий сторонній вміст. Приклади — середовища виконання контейнерів (containerd, CRI-O, Docker), мережеві політики (втулки CNI), контролери Ingress і логування.

Документація може посилатися на стороннє програмне забезпечення з відкритим кодом (OSS) поза проєктом Kubernetes лише тоді, коли воно потрібне для роботи Kubernetes.

Вміст із подвійним джерелом

Коли це можливо, документація Kubernetes посилається на канонічні джерела замість розміщення вмісту з подвійним джерелом.

Вміст із подвійним джерелом потребує вдвічі більше зусиль (або й більше!) на підтримку і швидше застаріває.

Додаткова інформація

Якщо у вас є запитання щодо дозволеного вмісту, приєднайтеся до каналу #sig-docs у Kubernetes Slack і запитайте!

Що далі

• Ознайомтеся з посібником зі стилю.