[ English | 日本語 | English (United Kingdom) | 한국어 (대한민국) | русский | 中文 (简体, 中国) | Deutsch | Indonesia | Türkçe (Türkiye) ]

Об этом руководстве

Эта страница описывает принятые соглашения и содержит подсказки по написанию этого руководства.

Соглашения

Руководство написано в формате синтакса reStructuredText (RST) с расширениями Sphinx. Большая часть принятых соглашений следует стандартам документации проекта OpenStack.

Ссылки ниже помогут вам в процессе написания документов в формате RST.

Заголовки

Принятые форматы заголовков:

=========
Heading 1
=========

Overline and underline with equal signs for heading 1 sections.
This level is reserved for the title in a document.

Heading 2
---------

Underline with dashes for heading 2 sections.

Heading 3
~~~~~~~~~

Underline with tildes for heading 3 sections.

Переводы

Это руководство само по себе является документом с несколькими переводами, выполненными в формате i18n, и вы можете перевести его на свой язык. Чтобы перевести его, посетите проект i18n в системе переводов Zanata. Документ с названием doc в проекте i18n и есть это самое руководство, которое вы сейчас читаете. Вы можете переводить его точно так же, как и другие проекты, такие как интерфейсы панелей управления или документацию. Как только объём перевода станет выше определённого порога (больше информации о пороге смотрите тут Задания, относящиеся к переводам), переведённая версия этого руководства будет опубликована.