diff options
| author | chenxing <chason.chan@foxmail.com> | 2019-06-14 19:10:25 +0800 |
|---|---|---|
| committer | chenxing <chason.chan@foxmail.com> | 2019-06-14 21:23:10 +0800 |
| commit | ae1e2e680867559fb97da869086ccfcfc4cbd62d (patch) | |
| tree | f114eae126cd0fa3f0ce1bb9ffe2b56de692de39 /doc/source/contributor | |
| parent | 39a2cf066c4c79436629017155302d36243aa338 (diff) | |
| download | kolla-ae1e2e680867559fb97da869086ccfcfc4cbd62d.tar.gz kolla-ae1e2e680867559fb97da869086ccfcfc4cbd62d.zip | |
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
Diffstat (limited to 'doc/source/contributor')
| -rw-r--r-- | doc/source/contributor/CONTRIBUTING.rst | 6 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 2 | ||||
| -rw-r--r-- | doc/source/contributor/running-tests.rst | 4 |
3 files changed, 5 insertions, 7 deletions
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 -<https://docs.openstack.org/kolla/latest/admin/image-building.html#dockerfile-customisation>`__) +customise various stages of the build (refer to :ref:`Dockerfile Customisation +<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 -<https://docs.openstack.org/oslotest/latest/user/features.html#debugging-with-oslo-debug-helper>`_. +For more information see the :oslotest-doc:`oslotest documentation +<user/features.html#debugging-with-oslo-debug-helper>`. .. rubric:: Footnotes |