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

このガイドについて

このページでは、このガイド自体を書く際の決まりごとやノウハウを説明します。

決まりごと

このガイドは reStructuredText (RST) マークアップ記法で書かれています。 Sphinx による拡張機能も使用できます。ほとんどの決まりごとは openstack-manuals プロジェクトのもの を踏襲しています。

RST でドキュメントを書く際には、以下のリンクが参考になります。

• Sphinx ドキュメント

• Quick 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) されており、自分の言語に翻訳できます。翻訳するには、 Zanata の i18n プロジェクトに行ってください。 i18n プロジェクトのドキュメント doc がこのガイドに該当します。翻訳方法は、ダッシュボードやマニュアルなどの他のプロジェクトと同じです。翻訳の進捗が一定のしきい値を超えると、このガイドの翻訳版が公開されます (しきい値の詳細については 翻訳関連のジョブ を参照してください)。