表記規則¶

OpenStack のドキュメントでは、以下の表記規則を採用しています。

注記¶

注記には以下の種類があります。

注釈

本文を補足する説明コメントです。

重要

続行する前に注意が必要なものです。

ちなみに

おまけですが、役に立つ実用的な助言です。

ご用心

ユーザーが間違いやすい箇所についてアドバイスです。

警告

データ損失やセキュリティー問題のリスクに関する致命的な情報です。

$ command

$ プロンプトから始まるコマンドは、 root ユーザーを含むすべてのユーザーが実行できます。

# command

# プロンプトから始まるコマンドは root ユーザーで実行する必要があります。これらのコマンドを実行するために sudo コマンドを使用することもできます。