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

关于这篇指南

本页面描述了在编写指南本身时需要遵守的约定，同时也给出了一些小提示。

约定

本指南使用包含了Sphinx扩展的reStructuredText（RST）标记语法编写。大多数的约定继承自 openstack-manuals 项目 。

以下是对使用RST编写文档有帮助的连接。

• Sphinx 文档

• reStructuredText快速指导

标题

标题级别的约定如下:

=========
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 上。i18n 项目里的 doc 文档就对应着本指南。你可以像翻译仪表盘和手册等其他项目一样来进行翻译。当翻译进度达到阈值（阈值细节见 翻译作业 ），翻译过的文档即可被自动发布。