The new home for these tools is
https://github.com/openstack-dev/heat-cfnclient
These tools are now aimed at heat developers only
and they will not be released or packaged.
Change-Id: I1ea62ef17e81ab53cacb5e4940f0c4e2516ed383
This patch adds initial input for the HOT template guide and the HOT
specification.
Note that content so far is based on features implemented so far and
not forward-looking in any way. Whenever new features get implemented,
the guide and spec will be extended appropriately.
Contributes to blueprint hot-specification
Change-Id: I63d29ab0a1db6703b39f981161063d4fd9f97126
quantumclient is gone upstream and has been replaced by neutronclient.
This patch retains the OS::Quantum::XX namespace
Fixes: bug #1197208
Change-Id: Id48f9598ea1884132d411ad533770ae49494102b
- Switched to definition lists for parameters to be consistent
with generated resource docs
- Make consistent the layout of literal blocks and returns
- Other minor grammatical and layout fixes
Change-Id: I62eb179ce2a20024d2195cc7eb88e2e79bd4ae68
There are separate pages for OpenStack, AWS and Rackspace resources.
Currently the following sources are used for resource type documentation:
- the docstring for the resource class
- properties_schema
- attributes_schema
Change-Id: I901d227e8bc2a7209f216b57653da77a4f500e47
Implements a resourcepages directive which generates resource type
documentation for any type that matches the specified type prefix.
For example:
.. resourcepages:: OS::
Implements blueprint generate-resource-docs
Change-Id: I3b2c94a766686e17e2bdbe8be27657decd65bb3e
updated index.rst to mimic the layout of the keystone docs
updated the structure for troubleshooting
ported howto guides from the heat wiki
ported the troubleshooting page from the heat wiki
updated the nav for the man pages and getting started
added docs for a cfn template and hot template
Change-Id: I14c1b0b6aa6ea3529c4de994851f7a798a3061bf
pbr injects version information as part of the build_sphinx command,
so having it here is overkill.
Change-Id: I1f89e068da3e47b94434cb71db87704f9665dea2
Support "Environment" section in the create/update body.
We the roll up the parameters and the environment and send
that as json using the rpc "params" argument. So no changes
to the rpc layer are needed. The engine knows how to deal
with both formats in the Environments class.
blueprint envirnonments
Change-Id: I6d6085d5c052a5f9115ecd46891b00d2fad4d1db
Update references to the to-be-removed in-tree templates, so
we use raw URLs to the heat-templates repo instead
Change-Id: I2121cedc2bffe1760d845dd2d87d97dd2265f1e9
Replace references to heat-jeos with documentation describing the
use of the new heat-templates/tools/heat-jeos.sh example script
fixes bug #1171602
Change-Id: I88fd2a5667cccd79a77c4a663c782fb537279fac
Load a single api-paste.ini file, specified by config
Delete unused paste.ini files
Update docs for new paste.ini and config arrangement
There will be a corresponding devstack change, and once this is in
I will email the packagers on the packaging implications
Change-Id: Ic10b1a486094d15bfd832f0f934e6268ec323085
Update GettingStarted to drop references to F16/essex and add the
password sed which is required when running grizzly installed via
tools/openstack on Fedora
Change-Id: I08d265e2e2388b54a6aa9f47c4930c32f71f3e93
These have been copied from the wiki.
DocImpact
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
Change-Id: I4c93bc5a1811e674cef3c7868e7cf9a457c12dea
This does not seem to be supported, so removing.
bug 1153681
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
Change-Id: I830980997438562d1ec241c33fcd8e67c32b21d9
Fix issue with release/version strings in doc build config
which was causing doc builds to fail with an error.
Fixes bug 1115269
Change-Id: Ia02d52f502d808d758a541e84056d5ac94aff8b8
Signed-off-by: Steven Hardy <shardy@redhat.com>
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
