Дотримання стандартів форматування

2 хвилин(и)

Ця сторінка показує стандарти форматування для документації Istio. Istio використовує Markdown для розмітки контенту та Hugo для створення вебсайту. Щоб забезпечити послідовність у нашій документації, ми погодилися на ці стандарти форматування.

Не використовуйте великі літери для наголосу

Використовуйте лише оригінальне написання великих літер у коді або файлах конфігурації при прямому посиланні на ці значення. Використовуйте зворотні лапки `` навколо посилання на значення, щоб зробити зв’язок явним. Наприклад, використовуйте IstioRoleBinding, а не Istio Role Binding або istio role binding.

Якщо ви не посилаєтеся безпосередньо на значення або код, використовуйте нормальне написання речень, наприклад, “Конфігурація прив’язки ролей Istio відбувається в YAML файлі.”

Використовуйте кутові дужки для заповнювачів

Використовуйте кутові дужки для заповнювачів у командах або прикладах коду. Скажіть читачеві, що представляє заповнювач. Наприклад:


1. Покажіть інформацію про pod:

    {{< text bash >}}
    $ kubectl describe pod <pod-name>
    {{< /text >}}

    Де `<pod-name>` — це імʼя одного з ваших pod.

Використовуйте жирний шрифт для підкреслення елементів інтерфейсу користувача

Зробіть	Не робіть
Натисніть Fork.	Натисніть “Fork”.
Виберіть Other.	Виберіть ‘Other’.

Використовуйте курсив для підкреслення нових термінів

Зробіть	Не робіть
Cluster — це набір вузлів …	“Cluster” — це набір вузлів …
Ці компоненти формують control plane.	Ці компоненти формують control plane.

Використовуйте шорткод gloss і додавайте записи глосарію для нових термінів.

Використовуйте `зворотні лапки` навколо імен файлів, тек і шляхів

Зробіть	Не робіть
Відкрийте файл `foo.yaml`.	Відкрийте файл foo.yaml.
Перейдіть до теки `/content/uk/docs/tasks`.	Перейдіть до теки /content/uk/docs/tasks.
Відкрийте файл `/data/args.yaml`.	Відкрийте файл /data/args.yaml.

Використовуйте `зворотні лапки` навколо інлайн коду та команд

Зробіть	Не робіть
Команда `foo run` створює `Deployment`.	Команда “foo run” створює `Deployment`.
Для декларативного управління використовуйте `foo apply`.	Для декларативного управління використовуйте “foo apply”.

Використовуйте блоки коду для команд, які ви сподіваєтесь, що будуть виконані читачами. Використовуйте інлайн код і команди лише для згадування конкретних міток, прапорців, значень, функцій, обʼєктів, змінних, модулів або команд.

Використовуйте `зворотні лапки` навколо імен полів обʼєктів

Зробіть	Не робіть
Встановіть значення поля `ports` у конфігураційному файлі.	Встановіть значення поля “ports” у конфігураційному файлі.
Значення поля `rule` є обʼєктом `Rule`.	Значення поля “rule” є обʼєктом `Rule`.