Skip to content

Commit 9e1840f

Browse files
authored
Merge pull request #32550 from Tellz777/content-guide
Edited content-guide.
2 parents f5bc7d5 + 6319b58 commit 9e1840f

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

content/ru/docs/contribute/style/content-guide.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -25,72 +25,72 @@ card:
2525

2626
### Контент, полученный из двух источников
2727

28-
Документация Kubernetes не содержит дублированный контент, полученный из разных мест (так называемый **контент из двумя источниками**). Контент из двух источников требует дублирования работы со стороны мейнтейнеров проекта и к тому же быстро теряет актуальность.
28+
Документация Kubernetes не содержит дублированный контент, полученный из разных мест (так называемый **контент из двух источников**). Контент из двух источников требует дублирования работы со стороны мейнтейнеров проекта и к тому же быстро теряет актуальность.
2929
Перед добавлением контента, задайте себе вопрос:
3030

31-
- Новая информация относится к действующему проекту CNCF ИЛИ проекту в организациях на GitHub kubernetes или kubernetes-sigs?
31+
- Новая информация относится к действующему проекту CNCF или проекту в организациях на GitHub kubernetes или kubernetes-sigs?
3232
- Если да, то:
3333
- У этого проекта есть собственная документация?
34-
- если да, то укажите ссылку на документацию проекта в документации Kubernetes
35-
- если нет, добавьте информацию в репозиторий проекта (если это возможно), а затем укажите ссылку на неё в документации Kubernetes
34+
- если да, то укажите ссылку на документацию проекта в документации Kubernetes.
35+
- если нет, добавьте информацию в репозиторий проекта (если это возможно), а затем укажите ссылку на неё в документации Kubernetes.
3636
- Если нет, то:
3737
- Остановитесь!
38-
- Добавление информации по продуктам от других разработчиков не допускается
38+
- Добавление информации о продуктах от других разработчиков не допускается.
3939
- Не разрешено ссылаться на документацию и сайты сторонних разработчиков.
4040

4141
### Разрешенная и запрещённая информация
4242

4343
Есть несколько условий, когда в документации Kubernetes может быть информация, относящиеся не к проектам Kubernetes.
44-
Ниже перечислены основные категории по содержанию проектов, не касающихся к Kubernetes, а также приведены рекомендации о том, что разрешено, а что нет:
44+
Ниже перечислены основные категории по содержанию проектов, не касающихся Kubernetes, а также приведены рекомендации о том, что разрешено, а что нет:
4545

46-
1. Инструкции по установке или эксплуатации Kubernetes, которые не связаны с проектами Kubernetes
46+
1. Инструкции по установке или эксплуатации Kubernetes, которые не связаны с проектами Kubernetes.
4747
- Разрешено:
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).
5252
- Запрещено:
53-
- Добавление информацию, которая повторяет документацию в другом репозитории
53+
- Добавление информации, которая дублирует документацию в другом репозитории.
5454
- Примеры:
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 и других окружений для выполнения контейнеров в разных операционных системах.
5757
- Добавление инструкций по установке Kubernetes в промышленных окружениях, используя разные проекты:
58-
-Kubernetes Rebar Integrated Bootstrap (KRIB) — это проект стороннего разработчика, поэтому все содержимое находится репозитории разработчика.
58+
- Kubernetes Rebar Integrated Bootstrap (KRIB) — это проект стороннего разработчика, поэтому всё содержимое находится в репозитории разработчика.
5959
- У проекта [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) или как этот проект разработан.
6464

6565
Добавление такого типа информации в документацию Kubernetes не допускается.
66-
1. Информация стороннему проекту
66+
1. Информация стороннему проекту.
6767
- Разрешено:
68-
- Добавление краткого введения о CNCF-проекте или проекте в GitHub-организациях kubernetes или kubernetes-sigs; этот абзац может содержать ссылки на проект
68+
- Добавление краткого введения о CNCF-проекте или проекте в GitHub-организациях kubernetes или kubernetes-sigs; этот абзац может содержать ссылки на проект.
6969
- Запрещено:
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. Только ссылки на сторонний проект.
7575
- Разрешено:
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.
8080
- Запрещено:
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. Содержание учебных курсов.
8686
- Разрешено:
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/).
8989
- Запрещено:
90-
- Ссылаться на учебныЕе онлайн-курсы, вне CNCF, Linux Foundation или Linux Academy; документация Kubernetes не содержит ссылок на сторонний контент
90+
- Ссылаться на учебные онлайн-курсы, не относящиеся к CNCF, Linux Foundation или Linux Academy; документация Kubernetes не содержит ссылок на сторонний контент.
9191
- Пример: добавление ссылок на учебные руководства или курсы 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/)
9494

9595
Если у вас есть вопросы по поводу допустимого контента, присоединяйтесь к каналу #sig-docs в [Slack Kubernetes](http://slack.k8s.io/)!
9696

0 commit comments

Comments
 (0)