content-guide_fix
Ilya Z
parent
b33b54b447
commit
6319b586d6
|
|
@ -25,72 +25,72 @@ card:
|
||||||
|
|
||||||
### Контент, полученный из двух источников
|
### Контент, полученный из двух источников
|
||||||
|
|
||||||
Документация Kubernetes не содержит дублированный контент, полученный из разных мест (так называемый **контент из двумя источниками**). Контент из двух источников требует дублирования работы со стороны мейнтейнеров проекта и к тому же быстро теряет актуальность.
|
Документация Kubernetes не содержит дублированный контент, полученный из разных мест (так называемый **контент из двух источников**). Контент из двух источников требует дублирования работы со стороны мейнтейнеров проекта и к тому же быстро теряет актуальность.
|
||||||
Перед добавлением контента, задайте себе вопрос:
|
Перед добавлением контента, задайте себе вопрос:
|
||||||
|
|
||||||
- Новая информация относится к действующему проекту CNCF ИЛИ проекту в организациях на GitHub kubernetes или kubernetes-sigs?
|
- Новая информация относится к действующему проекту CNCF или проекту в организациях на GitHub kubernetes или kubernetes-sigs?
|
||||||
- Если да, то:
|
- Если да, то:
|
||||||
- У этого проекта есть собственная документация?
|
- У этого проекта есть собственная документация?
|
||||||
- если да, то укажите ссылку на документацию проекта в документации Kubernetes
|
- если да, то укажите ссылку на документацию проекта в документации Kubernetes.
|
||||||
- если нет, добавьте информацию в репозиторий проекта (если это возможно), а затем укажите ссылку на неё в документации Kubernetes
|
- если нет, добавьте информацию в репозиторий проекта (если это возможно), а затем укажите ссылку на неё в документации Kubernetes.
|
||||||
- Если нет, то:
|
- Если нет, то:
|
||||||
- Остановитесь!
|
- Остановитесь!
|
||||||
- Добавление информации по продуктам от других разработчиков не допускается
|
- Добавление информации о продуктах от других разработчиков не допускается.
|
||||||
- Не разрешено ссылаться на документацию и сайты сторонних разработчиков.
|
- Не разрешено ссылаться на документацию и сайты сторонних разработчиков.
|
||||||
|
|
||||||
### Разрешенная и запрещённая информация
|
### Разрешенная и запрещённая информация
|
||||||
|
|
||||||
Есть несколько условий, когда в документации Kubernetes может быть информация, относящиеся не к проектам Kubernetes.
|
Есть несколько условий, когда в документации Kubernetes может быть информация, относящиеся не к проектам Kubernetes.
|
||||||
Ниже перечислены основные категории по содержанию проектов, не касающихся к Kubernetes, а также приведены рекомендации о том, что разрешено, а что нет:
|
Ниже перечислены основные категории по содержанию проектов, не касающихся Kubernetes, а также приведены рекомендации о том, что разрешено, а что нет:
|
||||||
|
|
||||||
1. Инструкции по установке или эксплуатации Kubernetes, которые не связаны с проектами Kubernetes
|
1. Инструкции по установке или эксплуатации Kubernetes, которые не связаны с проектами Kubernetes.
|
||||||
- Разрешено:
|
- Разрешено:
|
||||||
- Ссылаться на документацию на CNCF-проекта или на проект в GitHub-организациях kubernetes или kubernetes-sigs
|
- Ссылаться на документацию CNCF-проекта или на проект в GitHub-организациях kubernetes или kubernetes-sigs.
|
||||||
- Пример: для установки Kubernetes в процессе обучения нужно обязательно установить и настроить minikube, а также сослаться на соответствующую документацию minikube
|
- Пример: для установки Kubernetes в процессе обучения нужно обязательно установить и настроить minikube, а также сослаться на соответствующую документацию minikube.
|
||||||
- Добавление инструкций для проектов в организации kubernetes или kubernetes-sigs, если по ним нет инструкций
|
- Добавление инструкций для проектов в организации kubernetes или kubernetes-sigs, если по ним нет инструкций.
|
||||||
- Пример: добавление инструкций по установке и решению неполадок [kubadm](https://github.com/kubernetes/kubeadm)
|
- Пример: добавление инструкций по установке и решению неполадок [kubeadm](https://github.com/kubernetes/kubeadm).
|
||||||
- Запрещено:
|
- Запрещено:
|
||||||
- Добавление информацию, которая повторяет документацию в другом репозитории
|
- Добавление информации, которая дублирует документацию в другом репозитории.
|
||||||
- Примеры:
|
- Примеры:
|
||||||
- Добавление инструкций по установке и настройке minikube; Minikube имеет собственную [документацию](https://minikube.sigs.k8s.io/docs/), которая включают эти инструкции
|
- Добавление инструкций по установке и настройке minikube; Minikube имеет собственную [документацию](https://minikube.sigs.k8s.io/docs/), которая включают эти инструкции.
|
||||||
- Добавление инструкций по установке Docker, CRI-O, containerd и других окружений для выполнения контейнеров в разных операционных системах
|
- Добавление инструкций по установке Docker, CRI-O, containerd и других окружений для выполнения контейнеров в разных операционных системах.
|
||||||
- Добавление инструкций по установке Kubernetes в промышленных окружениях, используя разные проекты:
|
- Добавление инструкций по установке Kubernetes в промышленных окружениях, используя разные проекты:
|
||||||
-Kubernetes Rebar Integrated Bootstrap (KRIB) — это проект стороннего разработчика, поэтому все содержимое находится репозитории разработчика.
|
- Kubernetes Rebar Integrated Bootstrap (KRIB) — это проект стороннего разработчика, поэтому всё содержимое находится в репозитории разработчика.
|
||||||
- У проекта [Kubernetes Operations (kops)](https://github.com/kubernetes/kops) есть инструкции по установке и руководства в GitHub-репозитории.
|
- У проекта [Kubernetes Operations (kops)](https://github.com/kubernetes/kops) есть инструкции по установке и руководства в GitHub-репозитории.
|
||||||
- У проекта [Kubespray](https://kubespray.io) есть собственная документация
|
- У проекта [Kubespray](https://kubespray.io) есть собственная документация.
|
||||||
- Добавление руководства, в котором объясняется, как выполнить задачу с использованием продукта определенного разработчика или проекта с открытым исходным кодом, не являющиеся CNCF-проектом или проектом в GitHub-организациях kubernetes или kubnetes-sigs.
|
- Добавление руководства, в котором объясняется, как выполнить задачу с использованием продукта определенного разработчика или проекта с открытым исходным кодом, не являющиеся CNCF-проектами или проектом в GitHub-организациях kubernetes, или kubernetes-sigs.
|
||||||
- Добавление руководства по использованию CNCF-проекта или проекта в GitHub-организациях kubernetes или kubnetes-sigs, если у проекта есть собственная документация
|
- Добавление руководства по использованию CNCF-проекта или проекта в GitHub-организациях kubernetes или kubernetes-sigs, если у проекта есть собственная документация.
|
||||||
1. Подробное описание технических аспектов по использованию стороннего проекта (не Kubernetes) или как этот проект разработан
|
1. Подробное описание технических аспектов по использованию стороннего проекта (не Kubernetes) или как этот проект разработан.
|
||||||
|
|
||||||
Добавление такого типа информации в документацию Kubernetes не допускается.
|
Добавление такого типа информации в документацию Kubernetes не допускается.
|
||||||
1. Информация стороннему проекту
|
1. Информация стороннему проекту.
|
||||||
- Разрешено:
|
- Разрешено:
|
||||||
- Добавление краткого введения о CNCF-проекте или проекте в GitHub-организациях kubernetes или kubernetes-sigs; этот абзац может содержать ссылки на проект
|
- Добавление краткого введения о CNCF-проекте или проекте в GitHub-организациях kubernetes или kubernetes-sigs; этот абзац может содержать ссылки на проект.
|
||||||
- Запрещено:
|
- Запрещено:
|
||||||
- Добавление информации по продукту определённого разработчика
|
- Добавление информации по продукту определённого разработчика.
|
||||||
- Добавление информации по проекту с открытым исходным кодом, который не является CNCF-проектом или проектом в GitHub-организациях kubernetes или kubnetes-sigs
|
- Добавление информации по проекту с открытым исходным кодом, который не является CNCF-проектом или проектом в GitHub-организациях kubernetes или kubernetes-sigs.
|
||||||
- Добавление информации, дублирующего документацию из другого проекта, независимо от оригинального репозитория
|
- Добавление информации, дублирующего документацию из другого проекта, независимо от оригинального репозитория.
|
||||||
- Пример: добавление документации для проекта [Kubernetes in Docker (KinD)](https://kind.sigs.k8s.io) в документацию Kubernetes
|
- Пример: добавление документации для проекта [Kubernetes in Docker (KinD)](https://kind.sigs.k8s.io) в документацию Kubernetes.
|
||||||
1. Только ссылки на сторонний проект
|
1. Только ссылки на сторонний проект.
|
||||||
- Разрешено:
|
- Разрешено:
|
||||||
- Ссылаться на проекты в GitHub-организациях kubernetes и kubernetes-sigs
|
- Ссылаться на проекты в GitHub-организациях kubernetes и kubernetes-sigs.
|
||||||
- Пример: добавление ссылок на [документацию](https://kind.sigs.k8s.io/docs/user/quick-start) проекта Kubernetes in Docker (KinD), который находится в GitHub-организации kubernetes-sigs
|
- Пример: добавление ссылок на [документацию](https://kind.sigs.k8s.io/docs/user/quick-start) проекта Kubernetes in Docker (KinD), который находится в GitHub-организации kubernetes-sigs.
|
||||||
- Добавление ссылок на действующие CNCF-проекты
|
- Добавление ссылок на действующие CNCF-проекты.
|
||||||
- Пример: добавление ссылок на [документацию](https://prometheus.io/docs/introduction/overview/) проекта Prometheus; Prometheus — это действующий проект CNCF
|
- Пример: добавление ссылок на [документацию](https://prometheus.io/docs/introduction/overview/) проекта Prometheus; Prometheus — это действующий проект CNCF.
|
||||||
- Запрещено:
|
- Запрещено:
|
||||||
- Ссылаться на продукты стороннего разработчика
|
- Ссылаться на продукты стороннего разработчика.
|
||||||
- Ссылаться на архивированные проекты CNCF
|
- Ссылаться на прекращенные проекты CNCF.
|
||||||
- Ссылаться на недействующие проекты в организациях GitHub в kubernetes и kubernetes-sigs
|
- Ссылаться на недействующие проекты в организациях GitHub в kubernetes и kubernetes-sigs.
|
||||||
- Ссылаться на проекты с открытым исходным кодом, которые не являются проектами CNCF или не находятся в организациях GitHub kubernetes или kubernetes-sigs.
|
- Ссылаться на проекты с открытым исходным кодом, которые не являются проектами CNCF или не находятся в организациях GitHub kubernetes, или kubernetes-sigs.
|
||||||
1. Содержание учебных курсов
|
1. Содержание учебных курсов.
|
||||||
- Разрешено:
|
- Разрешено:
|
||||||
- Ссылаться на независимые от разработчиков учебные курсы Kubernetes, предлагаемыми [CNCF](https://www.cncf.io/), [Linux Foundation](https://www.linuxfoundation.org/) и [Linux Academy](https://linuxacademy.com/) (партнер Linux Foundation)
|
- Ссылаться на независимые от разработчиков учебные курсы Kubernetes, предлагаемыми [CNCF](https://www.cncf.io/), [Linux Foundation](https://www.linuxfoundation.org/) и [Linux Academy](https://linuxacademy.com/) (партнер Linux Foundation).
|
||||||
- Пример: добавление ссылок на курсы Linux Academy, такие как [Kubernetes Quick Start](https://linuxacademy.com/course/kubernetes-quick-start/) в [Kubernetes Security](https://linuxacademy.com/course/kubernetes-security/)
|
- Пример: добавление ссылок на курсы Linux Academy, такие как [Kubernetes Quick Start](https://linuxacademy.com/course/kubernetes-quick-start/) и [Kubernetes Security](https://linuxacademy.com/course/kubernetes-security/).
|
||||||
- Запрещено:
|
- Запрещено:
|
||||||
- Ссылаться на учебныЕе онлайн-курсы, вне CNCF, Linux Foundation или Linux Academy; документация Kubernetes не содержит ссылок на сторонний контент
|
- Ссылаться на учебные онлайн-курсы, не относящиеся к CNCF, Linux Foundation или Linux Academy; документация Kubernetes не содержит ссылок на сторонний контент.
|
||||||
- Пример: добавление ссылок на учебные руководства или курсы Kubernetes на Medium, KodeKloud, Udacity, Coursera, learnk8s и т.д.
|
- Пример: добавление ссылок на учебные руководства или курсы Kubernetes на Medium, KodeKloud, Udacity, Coursera, learnk8s и т.д.
|
||||||
- Ссылаться на руководства определённых разработчиков вне зависимости от обучающей организации
|
- Ссылаться на руководства определённых разработчиков вне зависимости от обучающей организации.
|
||||||
- Пример: добавление ссылок на такие курсы 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/)
|
- Пример: добавление ссылок на такие курсы 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/)
|
||||||
|
|
||||||
Если у вас есть вопросы по поводу допустимого контента, присоединяйтесь к каналу #sig-docs в [Slack Kubernetes](http://slack.k8s.io/)!
|
Если у вас есть вопросы по поводу допустимого контента, присоединяйтесь к каналу #sig-docs в [Slack Kubernetes](http://slack.k8s.io/)!
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue