Слияние кода завершено, страница обновится автоматически
Мы приветствуем ваши вклады в документацию Calico.
Вместо того чтобы создавать задачу на GitHub, рекомендуется сделать Pull Request (PR). Вы скорее всего получите более быстрый ответ.
Процесс внесения вклада в документацию работает следующим образом.
master в ранний выпуск, если это применимо.Важно: Убедитесь, что ваш вклад соответствует руководству по стилю документации Calico.
Примечание: Для вкладов, затрагивающих только одну страницу, вы можете использовать кнопки Редактировать эту страницу в документальном сайте. Это позволяет вам пропустить несколько шагов процесса, описанного выше, но подходит только для небольших вкладов.
Мы также приглашаем вас просмотреть Организацию сайта документов, Организационные изменения, Синтаксис ссылок и RELEASING.md для дополнительной информации.
Мы используем GitHub Pages и Jekyll для обслуживания и постройки нашего сайта. Хотя есть несколько способов локального построения сайта, мы рекомендуем использовать наш образ Docker и файл Makefile в корне репозитория. Эти инструменты позволят вам построить сайт одним командой.
Необходимое условие: Docker.
Перейдите в корень репозитория и выполните следующую команду из терминального окна.
make serve
После завершения сборки она вернет URL как значение Server address:. Копируйте и вставьте этот URL в ваш браузер для просмотра сайта.
Примечание: Чтобы просмотреть изменения, сделанные в ветке master, выберите nightly на странице Releases.
Подсказка: Jekyll может занять некоторое время для отрисовки каждой страницы. Для ускорения сборки существует дополнительный
_config_dev.yml, который исключает все директории, кромеmaster. Вы можете включить его в сборку следующим образомjekyll serve --config _config.yml,_config_dev.yml. Альтернативно, вы можете активировать его черезmakeс использованием следующего окруженияDEV=true make serve.
Система CI/CD проекта Calico автоматически генерирует предварительный просмотр сайта со всеми изменениями в документах. Автоматический ответ на Pull Request будет содержать сообщение "Deploy preview for calico ready!" и предоставлять ссылку на предварительный просмотр. Если ваши изменения незначительны и вы не являетесь регулярным участником проекта, этот метод может быть проще, чем локальное построение сайта.
Примечание: Чтобы просмотреть изменения, сделанные в ветке master, выберите nightly на странице Releases.
Необходимое условие: Docker.
Чтобы проверить наличие сломанных ссылок, перейдите в корень репозитория и выполните следующую команду из терминального окна.
make htmlproofer
Отправка Pull Request запускает процесс непрерывной интеграции, который включает команду make htmlproofer. Любые ошибки от htmlproofer вызовут провал теста непрерывной интеграции вашего Pull Request, поэтому лучше всего выполнять эту проверку локально перед отправкой Pull Request.
Однако вы также можете выполнить эту проверку после отправки Pull Request и получения ошибки htmlproofer от работы Semaphore.
Допустим, есть один коммит, который делает изменения в директории master, и вы хотите применить эти изменения к директории v1.5.
Генерируйте diff. Пример команды следует ниже, которая сохраняет diff в файле my-patch.diff.
git diff f35c02fe73e6a64d187ee3f6e9298ca47ded91ab^1 f35c02fe73e6a64d187ee3f6e9298ca47ded91ab > my-patch.diff
Примените diff к целевой версийной директории.
git apply -p2 --directory=v1.5 my-patch.diff
-p2 удаляет /master с начала путей.--directory=v1.5 добавляет "v1.5" в начало путей.Проверьте результаты (git status, git diff, и т.д.) и сделайте коммит.
Документация разделена на следующие секции:
СправочникКроме разделов "Введение" и "Справочник", контент должен быть основан на задачах. Все верхние заголовки тем должны использовать глагол действия (например, настроить, включить, модифицировать) с начальным регистром. Например:
Настройте соседей BGP
Включите сетевое покрытие
Диагностика Calico
Используйте calicoctl в Kubernetes-развертывании
Настройте политику выхода в Kubernetes
Подробное описание компонентов или табличные данные конфигурации должны находиться в разделе Справочник.
Эта страница описывает Calico и основные причины использования его.
Calico можно установить во многих различных развертываниях, включая внутренние и облачные провайдеры. Этот раздел включает в себя, как установить автономный кластер Calico для рабочих нагрузок, и как установить Calico на хостах вне кластера. Этот раздел охватывает шаги до состояния "готов к работе". Любой шаг за этим состоянием должен быть добавлен к другим разделам.
Этот раздел содержит пост-установочные, задачи-ориентированные материалы.
Этот раздел содержит задачи-ориентированные материалы для сетевых возможностей с использованием Calico CNI и Calico IPAM.
Этот раздел содержит задачи-ориентированные материалы для обеспечения безопасности компонентов Calico, рабочих нагрузок и хостов вне кластера с использованием политик сети Calico.
Этот раздел содержит справочный материал, включая полные детали API и ресурсов. Добавьте варианты конфигураций в одном из справочных материалов для каждого компонента, и перечислите любые ограничения и рассмотрения при включении опций.
Примеры:
calicoctl текстаЧтобы создать главную страницу для URL пути, назовите файл index.md.
Если index.md имеет подтемы, скопируйте следующий контент и обновите его. Все ключи должны быть нижнего регистра для согласованности. Описание должно быть примерно 50-160 слов.
---
title: Установка Calico
description: Установите Calico на узлы и хосты для популярных оркестраторов, и установите командную строку интерфейса (CLI) calicoctl.
canonical_url: '/getting-started/index'
show_read_time: false
show_toc: false
---
{{ page.description }}
{% capture content %}{% include index.html %}{% endcapture %}
{{ content | replace: " ", "" }}
Внутри копий страницы в папках master и предыдущих выпусках, добавьте строку canonical_url под строкой title в метаданных страницы. Она должна содержать абсолютный путь к странице в текущем самой свежей папке. Пример: canonical_url: 'https://projectcalico.docs.tigera.io/v3.0/getting-started/kubernetes/'. Для более подробного обсуждения канонических URL, обратитесь к разделу Канонические URL.
Если вам нужно удалить или переименовать директорию или файл:
Убедитесь, что вы подстроили боковое меню навигации под новые изменения.
Обновите любые пути canonical_url, которые указывают на удаленную или переименованную страницу. Метаданные canonical_url всех предыдущих экземпляров страницы могут указывать на удаленную или переименованную страницу. Вам необходимо исправить эти страницы, чтобы они указывали на новый экземпляр страницы. Когда вы отправите свой Pull Request, htmlproofer отметит эти ошибки.
Пример удаления: Если вы удалите страницу из папок master и v3.0, вам нужно обновить путь canonical_url страницы в папке v2.6, чтобы он указывал на саму себя. Также вам потребуется обновить пути canonical_url всех предыдущих экземпляров страницы, чтобы они указывали на копию в папке v2.6. Эта копия становится новым каноническим экземпляром.
Пример переименования: Если вы переименуете страницу из папок master и v3.0, вам нужно обновить путь canonical_url страницы в папке v2.6, чтобы он указывал на новый путь. Также исправьте любые копии в предыдущих папках.
Для более подробного обсуждения канонических URL, обратитесь к разделу Канонические URL.
Именование и расположение боковой навигационной панели хранятся в _data/$VERSION/navbars/*. Jekyll автоматически сохраняет информацию из директории _data в доступной переменной с именем site.data. Верхнеуровневый макет (_layout/docwithnav.html) будет проходить по всем файлам в site.data[version].navbars, чтобы создать боковую панель на основе того, какая версия просматривается.
Примечание: Путь к индексному файлу в боковой панели (см. следующий раздел) должен заканчиваться слешем
/в YAML-файле. Путь к реальному файлу в боковой панели не должен заканчиваться слешем/в YAML-файле.
Чтобы связать страницу, которая не имеет имени index.md, пропустите заключительный слеш. Чтобы связать страницу с именем index.md, включите заключительный слеш. В следующей таблице представлены некоторые примеры.
| URL | Путь к файлу |
|---|---|
/начало-работы/kubernetes/ |
/начало-работы/kubernetes/index.md |
/начало-работы/kubernetes/troubleshooting |
/начало-работы/kubernetes/troubleshooting.md |
site.url, site.baseurl и absolute_url
site.baseurl
Для создания кликабельных ссылок на другие страницы сайта используйте ссылки, начинающиеся со: {{ site.baseurl }}. Например:
[Начните работу]({{ site.baseurl }}/начало-работы/)
Будет отображаться как:
<a href="/v3.8/начало-работы/">Начните работу</a>
**absolute_url**Фильтр absolute_url следует использовать всякий раз, когда вы не создаёте кликабельный элемент <a href='...'>, а вместо этого показываете пользователю URL для локального копирования. Общий пример — это загрузка манифестов или показ пользователям, как им применять команду kubectl apply -f https://....
Для абсолютных ссылок используйте {{ "/путь" | absolute_url }}. Например:
kubectl apply -f `{{ "/манифесты/calicoctl.yaml" | absolute_url }}`
Будет отображаться как:
kubectl apply -f `https://docs.tigera.io/v3.8/манифесты/calicoctl.yaml`
site.url
Это отображается как основной адрес сайта без префиксов версий. Используйте это, если вам нужно показывать пользователю URL для копирования, но хотите указать часть пути точно так же, как она записана, без добавления информации о версии страницы Jekyll. Например, если вам нужно связать жестко зафиксированную версию страницы:
kubectl apply -f `{{ site.url }}/v3.4/манифесты/calicoctl.yaml`
Будет отображаться как:
kubectl apply -f `https://docs.tigera.io/v3.4/манифесты/calicoctl.yaml`
Используйте следующий синтаксис для любой ссылки, которая выводит пользователя за пределы сайта документов; таким образом, ссылка открывается в отдельном окне.
{% include open-new-window.html text='НАЗВАНИЕ' url='URL' %}
Пример
{% include open-new-window.html text='Создайте кластер AKS и активируйте политику сети' url='https://docs.microsoft.com/en-us/azure/aks/use-network-policies' %}
Не включайте никаких заглавных букв в ваших ссылках.
Анкорная ссылка для каждого заголовка автоматически создается. Она состоит из названия заголовка, где каждое слово разделено дефисами. Удалите любые слеши из названия. Например, чтобы сослаться на заголовок, названный "Работа с контейнером calico/kube-controllers", на странице, расположенной по адресу https://projectcalico.docs.tigera.io/v3.0/справочник/kube-controllers/конфигурация, вы бы использовали следующее:
/{{ page.version }}/справочник/kube-controllers/конфигурация#работа-с-контейнером-calico-kube-controllers
Поскольку сайт документации включает содержимое для прошлых версий, а также для самой последней версии, он содержит множество дублирующихся страниц. Когда Google индексирует сайт, ему требуется знать, какой вариант мы предпочитаем. Мы используем jekyll-seo-tag для добавления канонических URL к каждой странице. Это помогает нам гарантировать, что самый свежий вариант страницы появляется первым при поиске информации через Google.
Каждая страница должна включать тег canonical_url, содержащий абсолютный путь к самому свежему варианту страницы, даже если этот вариант является самой страницей.
Вы не должны менять метаданные canonical_url, кроме случаев, когда вы добавляете, удаляете или переименовываете страницу.
На нашем сайте по умолчанию добавляется кнопка копирования к каждому блоку кода. Для обеспечения возможности успешного копирования и вставки кода читателями следует следовать рекомендациям по примерам кода в DOC_STYLE_GUIDE.
Для изменения поведения по умолчанию для блоков кода, которые не следует копировать, таких как ответы, добавьте {: .no-select-button}. Пример ниже.
Успешно создано 8 ресурсов
{: .no-select-button}
См. RELEASING.md
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )