openstack/openstack-manuals
Code Issues Proposed changes

One Support Appendix to rule them all

Browse Source 
Unify the two current resources and support chapters and add
the result as appendix to each manual.

Change-Id: Ib1ab424d36ddea0e9905ce6f85089659246d27ab
This commit is contained in:
Andreas Jaeger 2013-10-09 08:58:30 +02:00
parent 476ae9506c
commit 1f9cae2c42
9 changed files with 153 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/admin-guide-cloud/bk-admin-guide-cloud.xml
View File

@ -80,5 +80,5 @@
<xi:include href="ch_objectstorage.xml"/>
<xi:include href="ch_blockstorage.xml"/>
<xi:include href="ch_networking.xml"/>
<xi:include href="../common/ch_support.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>

93
doc/common/app_resources.xml
View File

@ -1,93 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook" version="5.0"
xml:id="resources">
<title>Resources</title>
<para>For the available OpenStack documentation, see <link
xlink:href="http://docs.openstack.org"
>docs.openstack.org</link>.</para>
<para>The following books explain how to configure and run an
OpenStack cloud:</para>
<itemizedlist>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
><citetitle>Cloud Administrator Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/trunk/config-reference/content/"
><citetitle>Configuration Reference</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/ops/"
><citetitle>Operations Guide</citetitle></link></para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/high-availability-guide/content/"
><citetitle>High Availability Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/sec/"
><citetitle>Security Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/image-guide/content/"
><citetitle>Virtual Machine Image Guide</citetitle></link>
</para>
</listitem>
</itemizedlist>
<para>The following books explain how to use the OpenStack
dashboard and command-line clients:</para>
<itemizedlist>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
><citetitle>API Quick Start</citetitle></link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/user-guide/content/"
><citetitle>End User Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/user-guide-admin/content/"
><citetitle>Admin User Guide</citetitle></link>
</para>
</listitem>
</itemizedlist>
<para>For assistance with OpenStack, go to <link
xlink:href="http://ask.openstack.org"
>ask.openstack.org</link>.</para>
<!-- <para>For the Rackspace SDKs, see the <link
xlink:href="http://developer.rackspace.com"
>Rackspace Developer Center</link>.</para> -->
<para>To provide feedback on documentation, join and use the
<email>openstack-docs@lists.openstack.org</email>
mailing list at <link
xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs"
>OpenStack Documentation Mailing List</link>,
or <link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>report a bug</link>.</para>
</appendix>

158
doc/common/ch_support.xml → doc/common/app_support.xml
View File

@ -1,22 +1,125 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<appendix 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="ch_support-and-troubleshooting">
xml:id="app_community_support">
<?dbhtml stop-chunking?>
<title>Community Support</title>
<para>Many OpenStack community members can answer questions and
help with bug suspicions. We are constantly improving and
adding to the main features of OpenStack, but if you have any
problems, do not hesitate to ask. Use the following resources
to get OpenStack support and troubleshoot your existing
installations.</para>
<simplesect>
<para>There are many resources available that will help you
further with running and using OpenStack. Many OpenStack
community members can answer questions and help with bug
suspicions. We are constantly improving and adding to the main
features of OpenStack, but if you have any problems, do not
hesitate to ask. Use the following resources to get OpenStack
support and troubleshoot your existing installations.</para>
<section xml:id="support-documentation">
<title>Documentation</title>
<para>For the available OpenStack documentation, see <link
xlink:href="http://docs.openstack.org"
>docs.openstack.org</link>.</para>
<para>The following books explain how to install an OpenStack cloud
and its components:
</para>
<itemizedlist>
<listitem>
<para>
<link xlink:href="http://docs.openstack.org/trunk/install-guide/install/zypper/content/">
<citetitle>Installation Guide for openSUSE</citetitle>
</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://docs.openstack.org/trunk/install-guide/install/yum/content/">
<citetitle>Installation Guide for Red Hat Enterprise Linux,
CentOS, and Fedora</citetitle>
</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://docs.openstack.org/trunk/install-guide/install/apt/content/">
<citetitle>Installation Guide for Ubuntu 12.04 (LTS)</citetitle>
</link>
</para>
</listitem>
</itemizedlist>
<para>The following books explain how to configure and run an
OpenStack cloud:</para>
<itemizedlist>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
><citetitle>Cloud Administrator Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/trunk/config-reference/content/"
><citetitle>Configuration Reference</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/ops/"
><citetitle>Operations Guide</citetitle></link></para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/high-availability-guide/content/"
><citetitle>High Availability Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/sec/"
><citetitle>Security Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para><link
xlink:href="http://docs.openstack.org/image-guide/content/"
><citetitle>Virtual Machine Image Guide</citetitle></link>
</para>
</listitem>
</itemizedlist>
<para>The following books explain how to use the OpenStack
dashboard and command-line clients:</para>
<itemizedlist>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
><citetitle>API Quick Start</citetitle></link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/user-guide/content/"
><citetitle>End User Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/user-guide-admin/content/"
><citetitle>Admin User Guide</citetitle></link>
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="support-ask_openstack">
<title>ask.openstack.org</title>
<para>During set up or testing, you might have questions about
how to do something or be in a situation where a feature
does not work correctly. Use the <link
xlink:href="ask.openstack.org"
xlink:href="http://ask.openstack.org"
>ask.openstack.org</link> site to ask questions and
get answers. When you visit the <link
xlink:href="http://ask.openstack.org"
@ -26,8 +129,8 @@ to give a clear, concise summary in the title and provide
as much detail as possible in the description. Paste in
your command output or stack traces, link to screen shots,
and so on.</para>
</simplesect>
<simplesect>
</section>
<section xml:id="support-mailing-lists">
<title>OpenStack mailing lists</title>
<para>A great way to get answers and insights is to post your
question or scenario to the OpenStack mailing list. You
@ -43,9 +146,9 @@ and so on.</para>
available at <link
xlink:href="http://wiki.openstack.org/MailingLists"
>http://wiki.openstack.org/MailingLists</link>.</para>
</simplesect>
<simplesect>
<title>The OpenStack Wiki search</title>
</section>
<section xml:id="support-wiki">
<title>The OpenStack Wiki</title>
<para>The <link xlink:href="http://wiki.openstack.org/"
>OpenStack wiki</link> contains content on a broad
range of topics but some of it sits a bit below the
@ -56,8 +159,8 @@ and so on.</para>
be sure to check back often. You can find the search box
in the upper right corner of any OpenStack wiki
page.</para>
</simplesect>
<simplesect>
</section>
<section xml:id="support-bugs-area">
<title>The Launchpad Bugs area</title>
<para>So you think you've found a bug. That's great!
Seriously, it is. The OpenStack community values your set
@ -134,8 +237,8 @@ xlink:href="https://bugs.launchpad.net/ceilometer"
>Bugs : OpenStack Metering (ceilometer)</link></para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
</section>
<section xml:id="support-irc-channel">
<title>The OpenStack IRC channel</title>
<para>The OpenStack community lives and breathes in the
#openstack IRC channel on the Freenode network. You can
@ -162,5 +265,18 @@ xlink:href="https://bugs.launchpad.net/ceilometer"
list of all OpenStack-related IRC channels at <link
xlink:href="https://wiki.openstack.org/wiki/IRC"
>https://wiki.openstack.org/wiki/IRC</link>.</para>
</simplesect>
</chapter>
</section>
<section xml:id="support-documentation-feedback">
<title>Documentation feedback</title>
<para>To provide feedback on documentation, join and use the
<email>openstack-docs@lists.openstack.org</email>
mailing list at <link
xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs"
>OpenStack Documentation Mailing List</link>,
or <link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>report a bug</link>.
</para>
</section>
</appendix>

2
doc/config-reference/bk-config-ref.xml
View File

@ -78,5 +78,7 @@
<xi:include href="ch_objectstorageconfigure.xml"/>
<!-- Block Storage -->
<xi:include href="ch_blockstorageconfigure.xml"/>
<!-- Support -->
<xi:include href="../common/app_support.xml"/>
</book>

2
doc/image-guide/bk-imageguide.xml
View File

@ -71,5 +71,5 @@
<xi:include href="ch_creating_images_manually.xml"/>
<xi:include href="ch_creating_images_automatically.xml"/>
<xi:include href="ch_converting.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>

17
doc/install-guide/bk_openstackinstallguide.xml
View File

@ -45,19 +45,19 @@
<abstract>
<para>The OpenStack™ system consists of several key projects that
are separately installed but can work together depending on your
cloud needs: these projects include OpenStack Compute,
OpenStack Object Storage, the OpenStack Identity Service,
and the OpenStack Image Service. You can install any of these
projects separately and then configure them either as standalone
or connected entities.
<phrase os="ubuntu">This guide walks through an
cloud needs: these projects include OpenStack Compute,
OpenStack Object Storage, the OpenStack Identity Service,
and the OpenStack Image Service. You can install any of these
projects separately and then configure them either as standalone
or connected entities.
<phrase os="ubuntu">This guide walks through an
installation using packages available through
Ubuntu 12.04 (LTS).</phrase>
<phrase os="rhel;centos;fedora">This guide shows you
how to install OpenStack by using packages
available through Fedora 19 as well as on
Red Hat Enterprise Linux and its derivatives via
the EPEL repository.</phrase>
Red Hat Enterprise Linux and its derivatives via
the EPEL repository.</phrase>
<phrase os="opensuse">This guide shows you
how to install OpenStack by using packages
on openSUSE through the Open Build Service Cloud
@ -506,4 +506,5 @@
<xi:include href="ch_cinder.xml"/>
<xi:include href="ch_swift.xml"/>
<xi:include href="ch_neutron.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>

1
doc/security-guide/bk_openstack-sec-guide.xml
View File

@ -101,5 +101,6 @@
<xi:include href="ch064_certifications-compliance-statements.xml"/>
<xi:include href="ch065_privacy.xml"/>
<xi:include href="ch066_case-studies-compliance.xml"/>
<xi:include href="../common/app_support.xml"/>
<glossary role="auto"/>
</book>

2
doc/user-guide-admin/bk-admin-user-guide.xml
View File

@ -61,5 +61,5 @@
<xi:include href="ch_dashboard.xml"/>
<xi:include href="ch_cli.xml"/>
<xi:include href="../common/app_command_reference.xml"/>
<xi:include href="../common/app_resources.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>

2
doc/user-guide/bk-user-guide.xml
View File

@ -70,5 +70,5 @@
<xi:include href="ch_dashboard.xml"/>
<xi:include href="ch_cli.xml"/>
<xi:include href="../common/app_command_reference.xml"/>
<xi:include href="../common/app_resources.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>