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

About this guide

This page describes the conventions and tips on writing this guide itself.

Convention

The guide is written in reStructuredText (RST) markup syntax with Sphinx extensions. Most conventions follow those of the openstack-manuals project.

The followings are useful links when writing documents in RST.

• Sphinx documentation

• Quick reStructuredText

Titles

The convention for heading levels is as follows:

=========
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.

Translation

This guide itself is I18n-ed and you can translate it into your language. To translate it, visit i18n project in Zanata. Document doc in i18n project corresponds to this guide. You can translate it in the same way as you do for other projects like dashboard or manuals. Once the translation progress becomes higher than the threshold (For more information on the threshold, see Translation jobs), the translated version of the guide will be published.