ab6b5f6b2f
- For each audience, end user and admin user, add a paragraph in the first section about who the book is intended for. - Also edited Conventions and Doc History sections Change-Id: I89fdbd9b62515357e434b7a27cc26455e1541efc
41 lines
1.6 KiB
XML
41 lines
1.6 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 these forms:</para>
|
|
<note>
|
|
<para>A handy tip or reminder.</para>
|
|
</note>
|
|
<important>
|
|
<para>Something you must be aware of before proceeding.</para>
|
|
</important>
|
|
<warning>
|
|
<para>Critical information about the risk of data loss or security issues.</para>
|
|
</warning>
|
|
</simplesect>
|
|
<simplesect xml:id="conventions-prompts">
|
|
<title>Command prompts</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><emphasis role="bold"><prompt>$</prompt> prompt</emphasis></term>
|
|
<listitem>
|
|
<para>Any user, including the <literal>root</literal> user, can run commands that are
|
|
prefixed with the <prompt>$</prompt> prompt.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><emphasis role="bold"><prompt>#</prompt> prompt</emphasis></term>
|
|
<listitem>
|
|
<para>The <literal>root</literal> user must run commands that are prefixed with the
|
|
<prompt>#</prompt> prompt. You can also prefix these commands with the
|
|
<command>sudo</command> command, if available, to run them.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</simplesect>
|
|
</section>
|