c4777794e7
Here are some skeletons for the documentation which will need to be written.
doc/source
A Sphinx based document which will be aimed at heat developers.
This also contains .rst files which generate the man files
doc/docbkx/api-ref
Docbook and WADL for the REST API, with the intent of moving this
to api-site to publish to api.openstack.org
doc/docbkx/heat-admin
Docbook manual targeted at Heat admins, with the intent of moving this
to openstack-manuals to publish to docs.openstack.org
doc/docbkx/heat-cli
Docbook manual targeted at users of the Heat CLI, with the intent of
moving this to openstack-manuals to publish to docs.openstack.org
Dude, wheres my man pages?
docs/man
is deleted, now generated into doc/build/man
Packaging will need to be updated to generate the man pages
Change-Id: Idf2f37086b6f97df18ed57172de2f9e3d4c7706a
69 lines
2.5 KiB
XML
69 lines
2.5 KiB
XML
<!DOCTYPE preface [
|
|
<!-- Some useful entities borrowed from HTML -->
|
|
<!ENTITY ndash "–">
|
|
<!ENTITY mdash "—">
|
|
<!ENTITY hellip "…">
|
|
<!ENTITY plusmn "±">
|
|
|
|
<!-- Useful for describing APIs -->
|
|
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
|
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
|
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
|
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
|
|
|
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
|
<imageobject role="fo">
|
|
<imagedata fileref="figures/Check_mark_23x20_02.svg"
|
|
format="SVG" scale="60"/>
|
|
</imageobject>
|
|
<imageobject role="html">
|
|
<imagedata fileref="../figures/Check_mark_23x20_02.png"
|
|
format="PNG" />
|
|
</imageobject>
|
|
</inlinemediaobject>'>
|
|
|
|
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
|
<imageobject role="fo">
|
|
<imagedata fileref="figures/Arrow_east.svg"
|
|
format="SVG" scale="60"/>
|
|
</imageobject>
|
|
<imageobject role="html">
|
|
<imagedata fileref="../figures/Arrow_east.png"
|
|
format="PNG" />
|
|
</imageobject>
|
|
</inlinemediaobject>'>
|
|
<!ENTITY SENova 'services extension'>
|
|
<!ENTITY uSENova 'Services extension'>
|
|
<!ENTITY uuSENova 'Services Extension'>
|
|
<!ENTITY RSNova 'reset state extension'>
|
|
<!ENTITY uRSNova 'Reset state extension'>
|
|
<!ENTITY uuRSNova 'Reset State Extension'>
|
|
<!ENTITY ngCS 'next generation Rackspace Cloud Servers™ <link
|
|
xlink:href="http://www.rackspace.com/cloud/openstack/"
|
|
>powered by OpenStack</link>'>
|
|
<!ENTITY ungCS 'Next generation Rackspace Cloud Servers™ <link
|
|
xlink:href="http://www.rackspace.com/cloud/openstack/"
|
|
>powered by OpenStack</link>'>
|
|
]>
|
|
<preface 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_preface">
|
|
<title>Preface</title>
|
|
<section xml:id="Intended_Audience-d1e85">
|
|
<title>Intended Audience</title>
|
|
<para>TODO</para>
|
|
</section>
|
|
<section xml:id="Document_Change_History-d1e118">
|
|
<title>Document Change History</title>
|
|
<para>The most recent changes are described in the table
|
|
below:</para>
|
|
<?rax revhistory?>
|
|
</section>
|
|
<section xml:id="resources">
|
|
<title>Resources</title>
|
|
<para>TODO</para>
|
|
</section>
|
|
<?hard-pagebreak?>
|
|
</preface>
|