doc: Start using openstackdoctheme's extlink extension

This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I7c979dacd89ebead404b751d596ba120b38f00f3
This commit is contained in:
chenxing 2019-06-14 19:10:25 +08:00
parent 39a2cf066c
commit ae1e2e6808
7 changed files with 17 additions and 18 deletions

View File

@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0 openstackdocstheme>=1.19.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD

View File

@ -1,5 +1,3 @@
.. _image-building:
========================= =========================
Building Container Images Building Container Images
========================= =========================
@ -151,9 +149,8 @@ repository named ``mykollarepo``:
kolla-build -n mykollarepo --push kolla-build -n mykollarepo --push
To push images to a `local registry To push images to a :kolla-ansible-doc:`local registry
<https://docs.openstack.org/kolla-ansible/latest/user/multinode.html#deploy-a-registry>`_, <user/multinode.html#deploy-a-registry>`, use ``--registry`` flag:
use ``--registry`` flag:
.. code-block:: console .. code-block:: console
@ -217,6 +214,8 @@ overrides file, add the following:
RUN subscription-manager register --user=<user-name> \ RUN subscription-manager register --user=<user-name> \
--password=<password> && subscription-manager attach --pool <pool-id> --password=<password> && subscription-manager attach --pool <pool-id>
.. _dockerfile-customisation:
Dockerfile Customisation Dockerfile Customisation
======================== ========================
@ -534,9 +533,8 @@ Kolla-ansible with Local Registry
To make kolla-ansible pull images from a local registry, set To make kolla-ansible pull images from a local registry, set
``"docker_registry"`` to ``"172.22.2.81:5000"`` in ``"docker_registry"`` to ``"172.22.2.81:5000"`` in
``"/etc/kolla/globals.yml"``. Make sure Docker is allowed to pull images from ``"/etc/kolla/globals.yml"``. Make sure Docker is allowed to pull images from
insecure registry. See insecure registry. See :kolla-ansible-doc:`Docker Insecure Registry
`Docker Insecure Registry <user/multinode.html#deploy-a-registry>`.
<https://docs.openstack.org/kolla-ansible/latest/user/multinode.html#deploy-a-registry>`_.
Building behind a proxy Building behind a proxy
----------------------- -----------------------

View File

@ -88,3 +88,7 @@ latex_documents = [
repository_name = 'openstack/kolla' repository_name = 'openstack/kolla'
bug_project = 'kolla' bug_project = 'kolla'
bug_tag = '' bug_tag = ''
openstack_projects = [
'kolla-ansible',
'oslotest',
]

View File

@ -1,5 +1,3 @@
.. _CONTRIBUTING:
================= =================
How To Contribute How To Contribute
================= =================
@ -77,8 +75,8 @@ multiple processes generally use a base image and child images, for example,
``glance-base``, ``glance-api``, and ``glance-registry``. ``glance-base``, ``glance-api``, and ``glance-registry``.
Jinja2 'blocks' are employed throughout the Dockerfile's to help operators Jinja2 'blocks' are employed throughout the Dockerfile's to help operators
customise various stages of the build (refer to `Dockerfile Customisation customise various stages of the build (refer to :ref:`Dockerfile Customisation
<https://docs.openstack.org/kolla/latest/admin/image-building.html#dockerfile-customisation>`__) <dockerfile-customisation>`)
Some of these blocks are free form however, there are a subset that should be Some of these blocks are free form however, there are a subset that should be
common to every Dockerfile. The overall structure for a multi container service common to every Dockerfile. The overall structure for a multi container service

View File

@ -12,7 +12,7 @@ We welcome everyone to join our project!
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
CONTRIBUTING.rst CONTRIBUTING
running-tests running-tests
bug-triage bug-triage
ptl-guide ptl-guide

View File

@ -107,8 +107,8 @@ Then run :command:`tox` with the debug environment as one of the following:
tox -e debug tox -e debug
tox -e debug test_file_name.TestClass.test_name tox -e debug test_file_name.TestClass.test_name
For more information see the `oslotest documentation For more information see the :oslotest-doc:`oslotest documentation
<https://docs.openstack.org/oslotest/latest/user/features.html#debugging-with-oslo-debug-helper>`_. <user/features.html#debugging-with-oslo-debug-helper>`.
.. rubric:: Footnotes .. rubric:: Footnotes

View File

@ -194,8 +194,7 @@ A different motive for not using EXPOSE is the 20 microsecond penalty
applied to every packet forwarded and returned by docker-proxy. applied to every packet forwarded and returned by docker-proxy.
If EXPOSE functionality is desired, it can be added back by If EXPOSE functionality is desired, it can be added back by
referencing the default list of OpenStack ports to each Dockerfile: referencing the default list of OpenStack ports to each Dockerfile:
`Firewalls and default ports <https://docs.openstack.org/install-guide/firewalls-default-ports.html>`__.
https://docs.openstack.org/trunk/config-reference/content/firewalls-default-ports.html
We will use the docker flag --restart=always to provide some measure of We will use the docker flag --restart=always to provide some measure of
high availability for the individual containers and ensure they operate high availability for the individual containers and ensure they operate