openstack
/
heat
Code Issues Proposed changes

Merge "Docs: use local references for internal links"

This commit is contained in:
Zuul 2018-04-27 11:09:56 +00:00 committed by Gerrit Code Review
parent 45e8452e13 b78e78d8bb
commit 0ae3b75439
6 changed files with 18 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/_extra/.htaccess
View File

@ -1,3 +1,6 @@
# The top-level docs project will redirect URLs from the old /developer docs # The top-level docs project will redirect URLs from the old /developer docs
# to their equivalent pages on the new docs.openstack.org only if this file # to their equivalent pages on the new docs.openstack.org only if this file
# exists. # exists.
redirectmatch 301 ^/heat/([^/]+)/(architecture|pluginguide|schedulerhints|gmr|supportstatus)\.html$ /heat/$1/developing_guides/$2.html
redirectmatch 301 ^/heat/([^/]+)/(scale_deployment)\.html$ /heat/$1/operating_guides/$2.html

5
doc/source/install/index.rst
View File

@ -11,9 +11,8 @@ Installing Heat
launch-instance.rst launch-instance.rst
next-steps.rst next-steps.rst
The Orchestration service (heat) uses a The Orchestration service (heat) uses a :ref:`Heat Orchestration Template (HOT)
`Heat Orchestration Template (HOT) <http://docs.openstack.org/developer/heat/template_guide/hot_guide.html>`_ <hot_guide>` to create and manage cloud resources.
to create and manage cloud resources.
This chapter assumes a working setup of OpenStack following the This chapter assumes a working setup of OpenStack following the
`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_. `OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.

5
doc/source/install/launch-instance.rst
View File

@ -10,10 +10,7 @@ Create a template
----------------- -----------------
The Orchestration service uses templates to describe stacks. The Orchestration service uses templates to describe stacks.
To learn about the template language, see `the Template Guide To learn about the template language, see the :ref:`template-guide`.
<http://docs.openstack.org/developer/heat/template_guide/index.html>`__
in the `Heat developer documentation
<http://docs.openstack.org/developer/heat/index.html>`__.
* Create the ``demo-template.yml`` file with the following content: * Create the ``demo-template.yml`` file with the following content:

4
doc/source/install/next-steps.rst
View File

@ -8,5 +8,5 @@ Your OpenStack environment now includes the heat service.
To add more services, see the To add more services, see the
`additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ . `additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ .
To learn more about the heat service, read the `Heat developer documentation To learn more about the heat service, read the :doc:`Heat documentation
<http://docs.openstack.org/developer/heat/index.html>`__. <../index>`.

14
doc/source/operating_guides/scale_deployment.rst
View File

@ -33,9 +33,8 @@ This guide, using a devstack installation of OpenStack, assumes that:
1. You have configured devstack from `Single Machine Installation Guide 1. You have configured devstack from `Single Machine Installation Guide
<http://devstack.org/guides/single-machine.html>`_; <http://devstack.org/guides/single-machine.html>`_;
2. You have set up heat on devstack, as defined at `heat and DevStack 2. You have set up heat on devstack, as defined at :doc:`heat and DevStack
<http://docs.openstack.org/developer/heat/getting_started/ <../getting_started/on_devstack>`;
on_devstack.html>`_;
3. You have installed `HAProxy <http://haproxy.1wt.eu>`_ on the devstack 3. You have installed `HAProxy <http://haproxy.1wt.eu>`_ on the devstack
server. server.
@ -48,11 +47,10 @@ used and the target scaled out architecture.
Basic Architecture Basic Architecture
------------------ ------------------
The heat architecture is as defined at `heat architecture The heat architecture is as defined at :doc:`heat architecture
<http://docs.openstack.org/developer/heat/architecture.html>`_ and shown in the <../developing_guides/architecture>` and shown in the diagram below,
diagram below, where we have a CLI that sends HTTP requests to the REST and CFN where we have a CLI that sends HTTP requests to the REST and CFN APIs, which in
APIs, which in turn make calls using AMQP to the heat-engine. turn make calls using AMQP to the heat-engine::
::
|- [REST API] -| |- [REST API] -|
[CLI] -- <HTTP> -- -- <AMQP> -- [ENGINE] [CLI] -- <HTTP> -- -- <AMQP> -- [ENGINE]

8
doc/source/template_guide/hello_world.rst
View File

@ -51,10 +51,10 @@ could be used to deploy a single compute instance:
image: ubuntu-trusty-x86_64 image: ubuntu-trusty-x86_64
flavor: m1.small flavor: m1.small
Each HOT template must include the ``heat_template_version`` key with Each HOT template must include the ``heat_template_version`` key with the HOT
the HOT version value, for example, ``2013-05-23``. A list of HOT template version value, for example, ``2013-05-23``. Consult the :ref:`Heat template
versions can be found at `Heat Template Version version list <hot_spec_template_version>` for allowed values and their
file <http://docs.openstack.org/developer/heat/template_guide/hot_spec.html#heat-template-version>`__ features.
The ``description`` key is optional, however it is good practice to include The ``description`` key is optional, however it is good practice to include
some useful text that describes what users can do with the template. some useful text that describes what users can do with the template.