Эта страница предназначена для предоставления лучших практик при создании нового документа.
Hugo использует набор метаданных в начале страницы, называемых вступлением, чтобы указывать информацию, такую как название страницы и отображение ссылок в боковой панели.
Формат вступления должен выглядеть следующим образом:
---
# Эта секция называется "вступление" для вашей страницы
title: "Название вашей страницы" # Используйте прописные буквы для названий
linkTitle: "Шаблон: Новая страница с документацией"
# Поле linkTitle (выше) является необязательным; используйте его, чтобы предоставить более короткую ссылку, если название вашей страницы очень длинное
weight: 50 # Это влияет на расположение ссылки в боковой панели слева. Страницы располагаются сверху вниз по весу, от минимального до максимального.
type: "docs" # Вы не будете нуждаться в обновлении этого поля.
#aliases:
# - /docs/example/redirect/moved-renamed-page
# - /docs/another-example
# Была ли страница когда-либо перемещена? Если да, укажите предыдущее местоположение выше, начиная с пути от корня сайта (например /docs/, /blog/, или /community/). Старый URL будет переадресован на эту новую страницу. Для новых страниц "aliases" не требуются.
---
```Этот гайд показывает вам, как сделать что-то очень крутое. Убедитесь, что вы включили ценность для пользователя: например, этот гайд показывает вам, как выполнить X, что полезно для выполнения Y и Z. Убедитесь, что вы отвечаете на вопросы "что это за гайд?" и "почему кто-то захотел бы это сделать?".## Перед тем как начать
Вам потребуется:
- Кластер Kubernetes с установленной [Knative](docs/install/README.md). <!-- Обновите этот относительный путь в зависимости от того, где находится новая страница в структуре файлов. -->
- Любой другой необходимый материал?
## Разделите шаги на логические разделы
Избегайте помещения заголовков друг над другом без текста между ними.
1. Используйте упорядоченные списки для шагов.
2. Второй шаг.
3. Третий шаг.
<!-- Процессор markdown GitHub автоматически будет правильно управлять номерами в упорядоченных списках, если каждый список начинается с одного. На нашем сайте есть известная проблема с отображением номеров в упорядоченных списках (см. https://github.com/knative/docs/issues/1202),
но мы все равно рекомендуем авторам избегать использования ручного порядка в упорядоченных списках. -->
### Вы можете использовать более мелкие разделы внутри разделов для связанных задач
Избегайте вложения заголовков друг за другом без промежуточного текста.
Уместите код в блок кода.
1. Вот пример кода:
<!-- Используйте пробелы вместо табуляции для отступов в блоках кода, и оставьте одну пустую строку перед и после блока. -->
```bash
kubectl apply --filename=test.yaml
Другой пример кода:
kubectl apply --filename=test2.yaml
Всегда подробно объясняйте фрагменты кода, чтобы было понятно, как они работают или что делают.## Очистка
Если ваш гайд устанавливает образец приложения, покажите пользователю, как его удалить.
Предоставьте ссылки на другие относящиеся темы, если применимо. Как только пользователь завершит эти шаги, что он может захотеть сделать дальше?
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )