You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/ru/docs/contribute/style/content-guide.md
+40-40Lines changed: 40 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,72 +25,72 @@ card:
25
25
26
26
### Контент, полученный из двух источников
27
27
28
-
Документация Kubernetes не содержит дублированный контент, полученный из разных мест (так называемый **контент из двумя источниками**). Контент из двух источников требует дублирования работы со стороны мейнтейнеров проекта и к тому же быстро теряет актуальность.
28
+
Документация Kubernetes не содержит дублированный контент, полученный из разных мест (так называемый **контент из двух источников**). Контент из двух источников требует дублирования работы со стороны мейнтейнеров проекта и к тому же быстро теряет актуальность.
29
29
Перед добавлением контента, задайте себе вопрос:
30
30
31
-
- Новая информация относится к действующему проекту CNCF ИЛИ проекту в организациях на GitHub kubernetes или kubernetes-sigs?
31
+
- Новая информация относится к действующему проекту CNCF или проекту в организациях на GitHub kubernetes или kubernetes-sigs?
32
32
- Если да, то:
33
33
- У этого проекта есть собственная документация?
34
-
- если да, то укажите ссылку на документацию проекта в документации Kubernetes
35
-
- если нет, добавьте информацию в репозиторий проекта (если это возможно), а затем укажите ссылку на неё в документации Kubernetes
34
+
- если да, то укажите ссылку на документацию проекта в документации Kubernetes.
35
+
- если нет, добавьте информацию в репозиторий проекта (если это возможно), а затем укажите ссылку на неё в документации Kubernetes.
36
36
- Если нет, то:
37
37
- Остановитесь!
38
-
- Добавление информации по продуктам от других разработчиков не допускается
38
+
- Добавление информации о продуктах от других разработчиков не допускается.
39
39
- Не разрешено ссылаться на документацию и сайты сторонних разработчиков.
40
40
41
41
### Разрешенная и запрещённая информация
42
42
43
43
Есть несколько условий, когда в документации Kubernetes может быть информация, относящиеся не к проектам Kubernetes.
44
-
Ниже перечислены основные категории по содержанию проектов, не касающихся к Kubernetes, а также приведены рекомендации о том, что разрешено, а что нет:
44
+
Ниже перечислены основные категории по содержанию проектов, не касающихся Kubernetes, а также приведены рекомендации о том, что разрешено, а что нет:
45
45
46
-
1. Инструкции по установке или эксплуатации Kubernetes, которые не связаны с проектами Kubernetes
46
+
1. Инструкции по установке или эксплуатации Kubernetes, которые не связаны с проектами Kubernetes.
47
47
- Разрешено:
48
-
- Ссылаться на документацию на CNCF-проекта или на проект в GitHub-организациях kubernetes или kubernetes-sigs
49
-
- Пример: для установки Kubernetes в процессе обучения нужно обязательно установить и настроить minikube, а также сослаться на соответствующую документацию minikube
50
-
- Добавление инструкций для проектов в организации kubernetes или kubernetes-sigs, если по ним нет инструкций
51
-
- Пример: добавление инструкций по установке и решению неполадок [kubadm](https://github.com/kubernetes/kubeadm)
48
+
- Ссылаться на документацию CNCF-проекта или на проект в GitHub-организациях kubernetes или kubernetes-sigs.
49
+
- Пример: для установки Kubernetes в процессе обучения нужно обязательно установить и настроить minikube, а также сослаться на соответствующую документацию minikube.
50
+
- Добавление инструкций для проектов в организации kubernetes или kubernetes-sigs, если по ним нет инструкций.
51
+
- Пример: добавление инструкций по установке и решению неполадок [kubeadm](https://github.com/kubernetes/kubeadm).
52
52
- Запрещено:
53
-
- Добавление информацию, которая повторяет документацию в другом репозитории
53
+
- Добавление информации, которая дублирует документацию в другом репозитории.
54
54
- Примеры:
55
-
- Добавление инструкций по установке и настройке minikube; Minikube имеет собственную [документацию](https://minikube.sigs.k8s.io/docs/), которая включают эти инструкции
56
-
- Добавление инструкций по установке Docker, CRI-O, containerd и других окружений для выполнения контейнеров в разных операционных системах
55
+
- Добавление инструкций по установке и настройке minikube; Minikube имеет собственную [документацию](https://minikube.sigs.k8s.io/docs/), которая включают эти инструкции.
56
+
- Добавление инструкций по установке Docker, CRI-O, containerd и других окружений для выполнения контейнеров в разных операционных системах.
57
57
- Добавление инструкций по установке Kubernetes в промышленных окружениях, используя разные проекты:
58
-
-Kubernetes Rebar Integrated Bootstrap (KRIB) — это проект стороннего разработчика, поэтому все содержимое находится репозитории разработчика.
58
+
- Kubernetes Rebar Integrated Bootstrap (KRIB) — это проект стороннего разработчика, поэтому всё содержимое находится в репозитории разработчика.
59
59
- У проекта [Kubernetes Operations (kops)](https://github.com/kubernetes/kops) есть инструкции по установке и руководства в GitHub-репозитории.
60
-
- У проекта [Kubespray](https://kubespray.io) есть собственная документация
61
-
- Добавление руководства, в котором объясняется, как выполнить задачу с использованием продукта определенного разработчика или проекта с открытым исходным кодом, не являющиеся CNCF-проектом или проектом в GitHub-организациях kubernetes или kubnetes-sigs.
62
-
- Добавление руководства по использованию CNCF-проекта или проекта в GitHub-организациях kubernetes или kubnetes-sigs, если у проекта есть собственная документация
63
-
1. Подробное описание технических аспектов по использованию стороннего проекта (не Kubernetes) или как этот проект разработан
60
+
- У проекта [Kubespray](https://kubespray.io) есть собственная документация.
61
+
- Добавление руководства, в котором объясняется, как выполнить задачу с использованием продукта определенного разработчика или проекта с открытым исходным кодом, не являющиеся CNCF-проектами или проектом в GitHub-организациях kubernetes, или kubernetes-sigs.
62
+
- Добавление руководства по использованию CNCF-проекта или проекта в GitHub-организациях kubernetes или kubernetes-sigs, если у проекта есть собственная документация.
63
+
1. Подробное описание технических аспектов по использованию стороннего проекта (не Kubernetes) или как этот проект разработан.
64
64
65
65
Добавление такого типа информации в документацию Kubernetes не допускается.
66
-
1. Информация стороннему проекту
66
+
1. Информация стороннему проекту.
67
67
- Разрешено:
68
-
- Добавление краткого введения о CNCF-проекте или проекте в GitHub-организациях kubernetes или kubernetes-sigs; этот абзац может содержать ссылки на проект
68
+
- Добавление краткого введения о CNCF-проекте или проекте в GitHub-организациях kubernetes или kubernetes-sigs; этот абзац может содержать ссылки на проект.
69
69
- Запрещено:
70
-
- Добавление информации по продукту определённого разработчика
71
-
- Добавление информации по проекту с открытым исходным кодом, который не является CNCF-проектом или проектом в GitHub-организациях kubernetes или kubnetes-sigs
72
-
- Добавление информации, дублирующего документацию из другого проекта, независимо от оригинального репозитория
73
-
- Пример: добавление документации для проекта [Kubernetes in Docker (KinD)](https://kind.sigs.k8s.io) в документацию Kubernetes
74
-
1. Только ссылки на сторонний проект
70
+
- Добавление информации по продукту определённого разработчика.
71
+
- Добавление информации по проекту с открытым исходным кодом, который не является CNCF-проектом или проектом в GitHub-организациях kubernetes или kubernetes-sigs.
72
+
- Добавление информации, дублирующего документацию из другого проекта, независимо от оригинального репозитория.
73
+
- Пример: добавление документации для проекта [Kubernetes in Docker (KinD)](https://kind.sigs.k8s.io) в документацию Kubernetes.
74
+
1. Только ссылки на сторонний проект.
75
75
- Разрешено:
76
-
- Ссылаться на проекты в GitHub-организациях kubernetes и kubernetes-sigs
77
-
- Пример: добавление ссылок на [документацию](https://kind.sigs.k8s.io/docs/user/quick-start) проекта Kubernetes in Docker (KinD), который находится в GitHub-организации kubernetes-sigs
78
-
- Добавление ссылок на действующие CNCF-проекты
79
-
- Пример: добавление ссылок на [документацию](https://prometheus.io/docs/introduction/overview/) проекта Prometheus; Prometheus — это действующий проект CNCF
76
+
- Ссылаться на проекты в GitHub-организациях kubernetes и kubernetes-sigs.
77
+
- Пример: добавление ссылок на [документацию](https://kind.sigs.k8s.io/docs/user/quick-start) проекта Kubernetes in Docker (KinD), который находится в GitHub-организации kubernetes-sigs.
78
+
- Добавление ссылок на действующие CNCF-проекты.
79
+
- Пример: добавление ссылок на [документацию](https://prometheus.io/docs/introduction/overview/) проекта Prometheus; Prometheus — это действующий проект CNCF.
80
80
- Запрещено:
81
-
- Ссылаться на продукты стороннего разработчика
82
-
- Ссылаться на архивированные проекты CNCF
83
-
- Ссылаться на недействующие проекты в организациях GitHub в kubernetes и kubernetes-sigs
84
-
- Ссылаться на проекты с открытым исходным кодом, которые не являются проектами CNCF или не находятся в организациях GitHub kubernetes или kubernetes-sigs.
85
-
1. Содержание учебных курсов
81
+
- Ссылаться на продукты стороннего разработчика.
82
+
- Ссылаться на прекращенные проекты CNCF.
83
+
- Ссылаться на недействующие проекты в организациях GitHub в kubernetes и kubernetes-sigs.
84
+
- Ссылаться на проекты с открытым исходным кодом, которые не являются проектами CNCF или не находятся в организациях GitHub kubernetes, или kubernetes-sigs.
85
+
1. Содержание учебных курсов.
86
86
- Разрешено:
87
-
- Ссылаться на независимые от разработчиков учебные курсы Kubernetes, предлагаемыми [CNCF](https://www.cncf.io/), [Linux Foundation](https://www.linuxfoundation.org/) и [Linux Academy](https://linuxacademy.com/) (партнер Linux Foundation)
88
-
- Пример: добавление ссылок на курсы Linux Academy, такие как [Kubernetes Quick Start](https://linuxacademy.com/course/kubernetes-quick-start/)в[Kubernetes Security](https://linuxacademy.com/course/kubernetes-security/)
87
+
- Ссылаться на независимые от разработчиков учебные курсы Kubernetes, предлагаемыми [CNCF](https://www.cncf.io/), [Linux Foundation](https://www.linuxfoundation.org/) и [Linux Academy](https://linuxacademy.com/) (партнер Linux Foundation).
88
+
- Пример: добавление ссылок на курсы Linux Academy, такие как [Kubernetes Quick Start](https://linuxacademy.com/course/kubernetes-quick-start/)и[Kubernetes Security](https://linuxacademy.com/course/kubernetes-security/).
89
89
- Запрещено:
90
-
- Ссылаться на учебныЕе онлайн-курсы, вне CNCF, Linux Foundation или Linux Academy; документация Kubernetes не содержит ссылок на сторонний контент
90
+
- Ссылаться на учебные онлайн-курсы, не относящиеся к CNCF, Linux Foundation или Linux Academy; документация Kubernetes не содержит ссылок на сторонний контент.
91
91
- Пример: добавление ссылок на учебные руководства или курсы Kubernetes на Medium, KodeKloud, Udacity, Coursera, learnk8s и т.д.
92
-
- Ссылаться на руководства определённых разработчиков вне зависимости от обучающей организации
93
-
- Пример: добавление ссылок на такие курсы Linux Academy, как [Google Kubernetes Engine Deep Dive](https://linuxacademy.com/google-cloud-platform/training/course/name/google-kubernetes-engine-deep-dive)and[Amazon EKS Deep Dive](https://linuxacademy.com/course/amazon-eks-deep-dive/)
92
+
- Ссылаться на руководства определённых разработчиков вне зависимости от обучающей организации.
93
+
- Пример: добавление ссылок на такие курсы Linux Academy, как [Google Kubernetes Engine Deep Dive](https://linuxacademy.com/google-cloud-platform/training/course/name/google-kubernetes-engine-deep-dive)и[Amazon EKS Deep Dive](https://linuxacademy.com/course/amazon-eks-deep-dive/)
94
94
95
95
Если у вас есть вопросы по поводу допустимого контента, присоединяйтесь к каналу #sig-docs в [Slack Kubernetes](http://slack.k8s.io/)!
0 commit comments