From ae1e2e680867559fb97da869086ccfcfc4cbd62d Mon Sep 17 00:00:00 2001 From: chenxing Date: Fri, 14 Jun 2019 19:10:25 +0800 Subject: 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 --- doc/source/admin/image-building.rst | 14 ++++++-------- doc/source/conf.py | 4 ++++ doc/source/contributor/CONTRIBUTING.rst | 6 ++---- doc/source/contributor/index.rst | 2 +- doc/source/contributor/running-tests.rst | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) (limited to 'doc/source') diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst index 1f099802b..a0b756c8c 100644 --- a/doc/source/admin/image-building.rst +++ b/doc/source/admin/image-building.rst @@ -1,5 +1,3 @@ -.. _image-building: - ========================= Building Container Images ========================= @@ -151,9 +149,8 @@ repository named ``mykollarepo``: kolla-build -n mykollarepo --push -To push images to a `local registry -`_, -use ``--registry`` flag: +To push images to a :kolla-ansible-doc:`local registry +`, use ``--registry`` flag: .. code-block:: console @@ -217,6 +214,8 @@ overrides file, add the following: RUN subscription-manager register --user= \ --password= && subscription-manager attach --pool +.. _dockerfile-customisation: + Dockerfile Customisation ======================== @@ -534,9 +533,8 @@ Kolla-ansible with Local Registry To make kolla-ansible pull images from a local registry, set ``"docker_registry"`` to ``"172.22.2.81:5000"`` in ``"/etc/kolla/globals.yml"``. Make sure Docker is allowed to pull images from -insecure registry. See -`Docker Insecure Registry -`_. +insecure registry. See :kolla-ansible-doc:`Docker Insecure Registry +`. Building behind a proxy ----------------------- diff --git a/doc/source/conf.py b/doc/source/conf.py index d4a23cab2..862ab85e9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -88,3 +88,7 @@ latex_documents = [ repository_name = 'openstack/kolla' bug_project = 'kolla' bug_tag = '' +openstack_projects = [ + 'kolla-ansible', + 'oslotest', +] diff --git a/doc/source/contributor/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst index 3d86d1c06..83632d44d 100644 --- a/doc/source/contributor/CONTRIBUTING.rst +++ b/doc/source/contributor/CONTRIBUTING.rst @@ -1,5 +1,3 @@ -.. _CONTRIBUTING: - ================= 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``. 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 +`) 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 diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 44766f0f6..40c5b0d19 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -12,7 +12,7 @@ We welcome everyone to join our project! .. toctree:: :maxdepth: 2 - CONTRIBUTING.rst + CONTRIBUTING running-tests bug-triage ptl-guide diff --git a/doc/source/contributor/running-tests.rst b/doc/source/contributor/running-tests.rst index ebd82007c..5d30703be 100644 --- a/doc/source/contributor/running-tests.rst +++ b/doc/source/contributor/running-tests.rst @@ -107,8 +107,8 @@ Then run :command:`tox` with the debug environment as one of the following: tox -e debug 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 +`. .. rubric:: Footnotes -- cgit v1.2.3