openstack-manuals/doc/training-guide/user-story-includes-template.xml
Diane Fleming 64b6c9261e Folder rename, file rename, flattening of directories
Current folder name	New folder name	        Book title
----------------------------------------------------------
basic-install 	        DELETE
cli-guide	        DELETE
common	                common
NEW	                admin-guide-cloud	Cloud Administrators Guide
docbkx-example	        DELETE
openstack-block-storage-admin 	DELETE
openstack-compute-admin 	DELETE
openstack-config 	config-reference	OpenStack Configuration Reference
openstack-ha 	        high-availability-guide	OpenStack High Availabilty Guide
openstack-image	        image-guide	OpenStack Virtual Machine Image Guide
openstack-install 	install-guide	OpenStack Installation Guide
openstack-network-connectivity-admin 	admin-guide-network 	OpenStack Networking Administration Guide
openstack-object-storage-admin 	DELETE
openstack-security 	security-guide	OpenStack Security Guide
openstack-training 	training-guide	OpenStack Training Guide
openstack-user 	        user-guide	OpenStack End User Guide
openstack-user-admin 	user-guide-admin	OpenStack Admin User Guide
glossary	        NEW        	OpenStack Glossary

bug: #1220407

Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7
author: diane fleming
2013-09-08 15:15:50 -07:00

67 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<chapter 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.0">
<title>Including external content for user stories, version 1.0</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>
<section xml:id="foobar-section">
<title>Descriptive Section Title</title>
<para>Including a whole file. Include as much description about what is being taught
here.</para>
<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>
<!-- this maps to user story "blah blah" -->
<xi:include href="https://raw.github.com/openstack/openstack-manuals/master/doc/src/docbkx/openstack-install/ch_installing-openstack-overview.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'scripted-dev-installation'])">
<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>
</section>
<section xml:id="fubar-section">
<title>Descriptive Section Title</title>
<para>Including a section of a file. Include as much description about what is being taught
here.</para>
<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>
<!-- this maps to user story "blah blah" -->
<xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'controller-os'])">
<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>
</section>
</chapter>