openstack-manuals/doc/training-guide/user-story-includes-template.xml
Tom Fifield 8f7d1bd81a Starts install guide chapter for neutron, cleanups
This begins the install guide chapter for neutron,
and cleans up some sections from the guide that will
not be used even as references.

* hypervisor_selection - not relevant for the adventure
where the choice is done prior, and makes some difficult
value judgement statemtnts

* scripted ubuntu install - not the purpose of this guide
and old content that isn't helpful for the rewrite

* image-troubleshooting - empty section, belongs in
cloud-admin-guide anyway

* vnc-console - already in image_install

* identity_config_keystone - already better done in
individual sections

* install nova-volume - very dated content, already
in cinder install

* basic install files - no longer needed for reference

Change-Id: I1979eeba091c7118db7cc30ad7c66f30345fe49d
2013-10-15 15:22:51 +11:00

49 lines
3.9 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="userstory-includes-template_version_1.1">
<title>Including external content for user stories, version 1.1</title>
<para>Save your user story file as associate-my-user-story-name, operator-my-user-story, etc. For
example my user story that I assigned myself is operator bug fix so the file name would be
operator-fix-documentation-bug.xml. See the operator-fix-documentation-bug.xml file in the
repository for more details.</para>
<para>The include statements below are meant to help you tell and teach the user story. Include as
much content as necessary. Use examples.</para>
<para>Create diagrams through gdraw. Export as png. Reference as local file in the /figures/
director. Share as 'Anyone With the Link' can 'Edit' and add URL to the description so anyone
else can update the original.</para>
<para>
<mediaobject><imageobject>
<imagedata fileref="figures/openstack-training-example-image.png" scale="20"/>
</imageobject></mediaobject>
big dummy example image</para>
<para>image source</para>
<para><link xlink:href="https://docs.google.com/drawings/d/1Tdn4SZLBdvQybW_nK_lO380YRIe5T6PsI0IyLH5XE3M/edit?usp=sharing">https://docs.google.com/drawings/d/1Tdn4SZLBdvQybW_nK_lO380YRIe5T6PsI0IyLH5XE3M/edit?usp=sharing</link></para>
<para><emphasis role="bold">Including a whole file. Include as much description about what is
being taught here.</emphasis></para>
<!-- this maps to cardXXX user story title "blah blah" -->
<!-- The basic install guide no longer exists. A new include needs to be found -->
<!--<xi:include href="../install-guide/basic-install-files/basic-install_architecture.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(/*/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include>-->
<para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug" xlink:show="new">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals.</link></para>
<para><emphasis role="bold">Including a section of a file. Include as much description about
what is being taught here.</emphasis></para>
<!-- this maps to cardXXX user story title "blah blah" -->
<!-- The basic install guide no longer exists. A new include needs to be found -->
<!--<xi:include href="../install-guide/basic-install-files/basic-install_controller-common.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'controller-os']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include>-->
<para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug" xlink:show="new">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals.</link></para>
</section>