openstack
/
operations-guide
Code Issues Proposed changes

Import conventions from os-manuals 

Provide a conventions section, copied from the openstack-manuals repository.

Change-Id: I4d9772bb3e17810d95ed117d248e8bb647fa57e6
This commit is contained in:
Gauvain Pocentek 2014-03-15 16:55:04 +01:00
parent dec3373c9b
commit 65ccedff4b
2 changed files with 58 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/openstack-ops/preface_ops.xml
View File

@ -455,4 +455,5 @@
if you know how to fix it. Also, a member of the OpenStack
doc-core team can triage the doc bug.</para>
</section>
<xi:include href="section_conventions.xml"/>
</preface>

57
doc/openstack-ops/section_conventions.xml Normal file
View File

@ -0,0 +1,57 @@
<?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">
<!-- This file is copied from
openstack-manuals/doc/common/section_conventions.xml.
Do not edit this file, edit the openstack-manuals one and copy it
here.-->
<?dbhtml stop-chunking?>
<title>Conventions</title>
<para>
The OpenStack documentation uses several typesetting conventions:
</para>
<simplesect xml:id="conventions-admonitions">
<title>Admonitions</title>
<para>
Admonitions take three forms:
</para>
<note>
<para>
This is a note. The information in a note is usually in the form
of a handy tip or reminder.
</para>
</note>
<important>
<para>
This is important. The information in an important admonition is
something you must be aware of before moving on.
</para>
</important>
<warning>
<para>
This is a warning. 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 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>