openstack/heat
Code Issues Proposed changes

Organise doc links for Operating Heat

Browse Source 
The second section of doc links is aimed at operators, so existing
content which affects operators has been moved here (package based
install, scaling, service man pages).

The yum/apt install pages have been simplified to point at
docs.openstack.org and any other community based installation resources
(RDO, Juju charms).

Change-Id: I3e89a288bf6b64ba286c11df1369e073d2c2a35e
This commit is contained in:
Steve Baker 2015-10-05 17:36:00 +13:00
parent a2d1b7ee38
commit 98f687c1bc
3 changed files with 33 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/getting_started/on_fedora.rst
View File

@ -11,22 +11,21 @@
License for the specific language governing permissions and limitations
under the License.
Getting Started With Heat on Fedora
===================================
Installing OpenStack and Heat on RHEL/Fedora/CentOS
---------------------------------------------------
Installing OpenStack and Heat on Fedora
---------------------------------------
Go to the `OpenStack Documentation <http://docs.openstack.org/>`_ for
the latest version of the Installation Guide for Red Hat Enterprise
Linux, CentOS and Fedora which includes a chapter on installing the
Orchestration module (Heat).
Heat requires an OpenStack release of Grizzly or newer, but bear in mind that Grizzly is EOL. The current stable release_ is, of course, recommended.
There are instructions for `installing the RDO OpenStack distribution
<https://www.rdoproject.org/Quickstart>`_ on Fedora and CentOS.
.. _release: https://wiki.openstack.org/wiki/Releases
If installing with packstack, you can install heat by specifying
``--os-heat-install=y`` in your packstack invocation, or setting
``CONFIG_HEAT_INSTALL=y`` in your anwsers file.
Instructions for installing the RDO OpenStack distribution on Fedora are available at ``http://openstack.redhat.com/Quickstart``
Instructions for installing Heat on RDO are also available at ``http://openstack.redhat.com/Docs``
Alternatively, if you require a development environment not a package-based install, the suggested method is devstack, see instructions at :doc:`on_devstack`
Example Templates
-----------------
Check out the example templates at ``https://github.com/openstack/heat-templates``. Here you can view example templates which will work with several Fedora versions.
If installing with `RDO-Manager
<https://www.rdoproject.org/RDO-Manager>`_ Heat will be installed by
default.

12
doc/source/getting_started/on_ubuntu.rst
View File

@ -11,13 +11,13 @@
License for the specific language governing permissions and limitations
under the License.
Getting Started With Heat on Ubuntu
===================================
Installing Heat on Ubuntu
-------------------------
Heat is packaged for Debian, and Ubuntu (from 13.10)
Alternatively, if you require a development environment not a package-based install, the suggested method is devstack, see instructions at :doc:`on_devstack`
Go to the `OpenStack Documentation <http://docs.openstack.org/>`_ for
the latest version of the Installation Guide for Ubuntu which includes a
chapter on installing the Orchestration module (Heat).
Example Templates
-----------------
Check out the example templates at ``https://github.com/openstack/heat-templates``.
There is a `Juju Charm for Heat <https://jujucharms.com/heat/>` available.

29
doc/source/index.rst
View File

@ -54,20 +54,23 @@ Using Heat
templates/index
glossary
Man Pages
=========
Operating Heat
==============
.. toctree::
:maxdepth: 2
man/index
Developers Documentation
========================
.. toctree::
:maxdepth: 1
getting_started/index
getting_started/on_fedora
getting_started/on_ubuntu
scale_deployment
man/index
Developing Heat
===============
.. toctree::
:maxdepth: 1
getting_started/on_devstack
architecture
pluginguide
schedulerhints
@ -81,12 +84,6 @@ API Documentation
.. _`Heat REST API Reference (OpenStack API Complete Reference - Orchestration)`: http://api.openstack.org/api-ref-orchestration-v1.html
Operations Documentation
========================
.. toctree::
:maxdepth: 1
scale_deployment
Code Documentation
==================