Fix links - and make them robust

There's no .md file in here, so change links. Looking at the used links,
these are all external links and thus sphinx cannot test whether they
work. Use internal links so that all links work - and work even after
renames.

This shows up as e.g.:
 WARNING: unknown document: install-maas.html

Update tox.ini so that these are hard errors.

Remove dead requirement oslosphinx, it's not needed anymore here since
openstackdocstheme is used.

Change-Id: Ieae398aecb48c2e26de5c50261e700f8790e64ce
changes/85/672985/1
Andreas Jaeger 3 years ago
parent 64a2dbac71
commit 60069b0276
  1. 4
      deploy-guide/source/install-juju.rst
  2. 2
      deploy-guide/source/install-maas.rst
  3. 6
      deploy-guide/source/install-openstack-bundle.rst
  4. 16
      deploy-guide/source/install-openstack.rst
  5. 1
      requirements.txt
  6. 2
      tox.ini

@ -5,7 +5,7 @@ Install Juju
tool that allows you to deploy, configure, scale and operate your software on
public and private clouds.
In the `previous step <./install-maas.html>`__, we installed, deployed and
In the :doc:`previous step <install-maas>`, we installed, deployed and
configured `MAAS <https://maas.io/>`__ to use as a foundation for Juju to deploy
a fully fledged OpenStack cloud.
@ -109,7 +109,7 @@ controller for our cloud:
The constraint in the above command will ask MAAS to use any nodes tagged with
``juju`` to host the controller for the Juju client. We tagged this node within
MAAS in the `previous step <./install-maas.md#commision-nodes>`__.
MAAS in the :ref:`previous step <commision_nodes>`.
The output to a successful bootstrap will look similar to the following:

@ -260,6 +260,8 @@ configuration may require.
Click ``Save changes`` when finished. You should now be able to power off the
machine using the ``Take action`` menu in the top right.
.. _commision_nodes:
Commission nodes
----------------

@ -1,7 +1,7 @@
Install OpenStack from a bundle
===============================
`Stepping through the deployment <./install-openstack.html>`__ of each OpenStack
:doc:`Stepping through the deployment <install-openstack>` of each OpenStack
application is the best way to understanding how OpenStack and Juju operate, and
how each application relates to one another. But it's a labour intensive
process.
@ -34,9 +34,9 @@ Monitor the output of ``juju status`` to see when everything is ready.
Next steps
----------
See the `Install OpenStack <./install-openstack.md#test-openstack>`__
See the :ref:`Install OpenStack <test_openstack>`
documentation for details on testing your OpenStack deployment, or jump directly
to `Configure OpenStack <./config-openstack.html>`__ to start using OpenStack
to :doc:`Configure OpenStack <config-openstack>` to start using OpenStack
productively as quickly as possible.
.. raw:: html

@ -1,8 +1,8 @@
Install OpenStack
=================
Now that we've installed and configured `MAAS <./install-maas.html>`__ and
successfully deployed a `Juju <./install-juju.html>`__ controller, it's time to
Now that we've installed and configured :doc:`MAAS <install-maas>` and
successfully deployed a :doc:`Juju <install-juju>` controller, it's time to
do some real work; use Juju to deploy
`OpenStack <https://www.openstack.org/>`__, the leading open cloud platform.
@ -23,14 +23,14 @@ recommend starting with the first option. This will give you a stronger
foundation for maintaining and expanding the default deployment. Our
instructions for this option continue below.
Alternatively, jump to `Deploying OpenStack as a
bundle <./install-openstack-bundle.html>`__ to learn about deploying as a
Alternatively, jump to :doc:`Deploying OpenStack as a
bundle <install-openstack-bundle>` to learn about deploying as a
bundle.
Deploy the Juju controller
--------------------------
`Previously <./install-juju.html>`__, we tested our MAAS and Juju configuration
:doc:`Previously <install-juju>`, we tested our MAAS and Juju configuration
by deploying a new Juju controller called ``maas-controller``. You can check
this controller is still operational by typing ``juju status``. With the Juju
controller running, the output will look similar to the following:
@ -497,6 +497,8 @@ All that's now left to do is wait on the output from ``juju status`` to show
when everything is ready (everything turns green, if your terminal support
colour).
.. _test_openstack:
Test OpenStack
--------------
@ -525,8 +527,8 @@ Next steps
----------
Congratulations, you've successfully deployed a working OpenStack environment
using both Juju and MAAS. The next step is to `configure
OpenStack <./config-openstack.html>`__ for use within a production environment.
using both Juju and MAAS. The next step is to :doc:`configure
OpenStack <config-openstack>` for use within a production environment.
.. raw:: html

@ -1,4 +1,3 @@
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 # BSD
oslosphinx>=2.5.0,!=3.4.0 # Apache-2.0
pbr>=1.6 # Apache-2.0
openstackdocstheme>=1.5.0,<1.18.0 # Apache-2.0

@ -15,4 +15,4 @@ basepython = python3
commands = {posargs}
[testenv:deploy-guide]
commands = sphinx-build -a -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html
commands = sphinx-build -a -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html

Loading…
Cancel
Save