From 65ccedff4b689d3cca020e331bfc3233d7f11bf0 Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain@pocentek.net>
Date: Sat, 15 Mar 2014 16:55:04 +0100
Subject: [PATCH] Import conventions from os-manuals

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

Change-Id: I4d9772bb3e17810d95ed117d248e8bb647fa57e6
---
 doc/openstack-ops/preface_ops.xml         |  1 +
 doc/openstack-ops/section_conventions.xml | 57 +++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 doc/openstack-ops/section_conventions.xml

diff --git a/doc/openstack-ops/preface_ops.xml b/doc/openstack-ops/preface_ops.xml
index 5fb215d7..366f634d 100644
--- a/doc/openstack-ops/preface_ops.xml
+++ b/doc/openstack-ops/preface_ops.xml
@@ -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>
diff --git a/doc/openstack-ops/section_conventions.xml b/doc/openstack-ops/section_conventions.xml
new file mode 100644
index 00000000..01ecb240
--- /dev/null
+++ b/doc/openstack-ops/section_conventions.xml
@@ -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>