Docs: use local references for internal links

Some internal links in the documentation are broken after the
re-organisation because they used absolute URLs. Use :ref:, or at least
:doc: instead and let Sphinx take care of keeping the links up to date.

Also add a redirect for docs we know to have moved, since they may be
linked from other places externally.

Change-Id: I107f40e23a757052da7f5179338f88369a4a72cb
Partial-Bug: #1710084
This commit is contained in:
Zane Bitter 2018-03-12 13:48:02 -04:00
parent dea4bd18e0
commit b78e78d8bb
6 changed files with 18 additions and 21 deletions

View File

@ -1,3 +1,6 @@
# 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
# 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

View File

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

View File

@ -10,10 +10,7 @@ Create a template
-----------------
The Orchestration service uses templates to describe stacks.
To learn about the template language, see `the 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>`__.
To learn about the template language, see the :ref:`template-guide`.
* Create the ``demo-template.yml`` file with the following content:

View File

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

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

View File

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