43 lines
1.5 KiB
XML
43 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="section_conventions">
|
|
<?dbhtml stop-chunking?>
|
|
<title>Conventions</title>
|
|
<para>The OpenStack documentation uses several typesetting
|
|
conventions.</para>
|
|
|
|
<simplesect xml:id="conventions-admonitions">
|
|
<title>Notices</title>
|
|
<para>Notices take three forms:</para>
|
|
<note>
|
|
<para>The information in a note is usually in the form of a
|
|
handy tip or reminder.</para>
|
|
</note>
|
|
<important>
|
|
<para>The information in an important notice is something you
|
|
must be aware of before proceeding.</para>
|
|
</important>
|
|
<warning>
|
|
<para>The information in warnings is critical. Warnings
|
|
provide additional information about risk of data loss or
|
|
security issues.</para>
|
|
</warning>
|
|
</simplesect>
|
|
|
|
<simplesect xml:id="conventions-prompts">
|
|
<title>Command prompts</title>
|
|
<para>Commands prefixed with the <literal>#</literal> prompt
|
|
are to be executed by the <literal>root</literal> user. These
|
|
examples can also be executed by using the
|
|
<command>sudo</command> command, if available.</para>
|
|
<para>
|
|
Commands prefixed with the <literal>$</literal> prompt can be
|
|
executed by any user, including <literal>root</literal>.
|
|
</para>
|
|
</simplesect>
|
|
|
|
</section>
|