From: Kefu Chai Date: Fri, 4 Sep 2020 16:12:51 +0000 (+0800) Subject: doc/dev: link to label not file X-Git-Tag: wip-pdonnell-testing-20200918.022351~124^2~3 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=40f9e1cee054bb568dfa3267982467c99b4ce5c5;p=ceph-ci.git doc/dev: link to label not file it's less error prone, and can help us avoid broken links if we move a file around Signed-off-by: Kefu Chai --- diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 446d4a3d5ad..177ae76a575 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -38,7 +38,7 @@ a practical summary of the same. Update the tracker ------------------ -Before you start, you should know the `Issue tracker`_ number of the bug +Before you start, you should know the :ref:`issue-tracker` number of the bug you intend to fix. If there is no tracker issue, now is the time to create one. @@ -195,7 +195,7 @@ the `Git Commit Good Practice`_ article at the `OpenStack Project Wiki`_. .. _`Git Commit Good Practice`: https://wiki.openstack.org/wiki/GitCommitMessages .. _`OpenStack Project Wiki`: https://wiki.openstack.org/wiki/Main_Page -Once your pull request (PR) is opened, update the `Issue tracker`_ by +Once your pull request (PR) is opened, update the :ref:`issue-tracker` by adding a comment to the bug pointing the other developers to your PR. The update can be as simple as:: @@ -208,7 +208,7 @@ When your PR hits GitHub, the Ceph project's `Continuous Integration (CI) `_ infrastructure will test it automatically. At the time of this writing (March 2016), the automated CI testing included a test to check that the -commits in the PR are properly signed (see `Submitting patches`_) and a +commits in the PR are properly signed (see :ref:`submitting-patches`) and a `make check`_ test. The latter, `make check`_, builds the PR and runs it through a battery of @@ -255,7 +255,7 @@ sub-directory`_ and are run via the `teuthology framework`_. .. _`teuthology framework`: https://github.com/ceph/teuthology The Ceph community has access to the `Sepia lab -`_ where `integration tests`_ can be +`_ where :ref:`testing-integration-tests` can be run on real hardware. Other developers may add tags like "needs-qa" to your PR. This allows PRs that need testing to be merged into a single branch and tested all at the same time. Since teuthology suites can take hours (even @@ -263,7 +263,7 @@ days in some cases) to run, this can save a lot of time. To request access to the Sepia lab, start `here `_. -Integration testing is discussed in more detail in the `integration testing`_ +Integration testing is discussed in more detail in the :ref:`testing-integration-tests` chapter. Code review @@ -272,7 +272,7 @@ Code review Once your bugfix has been thoroughly tested, or even during this process, it will be subjected to code review by other developers. This typically takes the form of correspondence in the PR itself, but can be supplemented -by discussions on `IRC`_ and the `Mailing list`_. +by discussions on :ref:`irc` and the :ref:`mailing-list`. Amending your PR ---------------- @@ -301,9 +301,9 @@ The bugfixing process culminates when one of the project leads decides to merge your PR. When this happens, it is a signal for you (or the lead who merged the PR) -to change the `Issue tracker`_ status to "Resolved". Some issues may be +to change the :ref:`issue-tracker` status to "Resolved". Some issues may be flagged for backporting, in which case the status should be changed to -"Pending Backport" (see the `Backporting`_ chapter for details). +"Pending Backport" (see the :ref:`backporting` chapter for details). See also :ref:`merging` for more information on merging. @@ -357,10 +357,3 @@ the **ptl-tool** have the following form:: .. _make check: -.. _Backporting: ../essentials/#backporting -.. _IRC: ../essentials/#irc -.. _Issue Tracker: ../issue-tracker -.. _Integration Tests: ../tests-integration-tests -.. _Integration Testing: ../tests-integration-tests -.. _Mailing List: ../essentials/#mailing-list -.. _Submitting Patches: ../essentials/#submitting-patches diff --git a/doc/dev/developer_guide/essentials.rst b/doc/dev/developer_guide/essentials.rst index a3427292504..b8edc8cc069 100644 --- a/doc/dev/developer_guide/essentials.rst +++ b/doc/dev/developer_guide/essentials.rst @@ -90,6 +90,8 @@ click on `New issue`_. .. _`jump to the Ceph project`: http://tracker.ceph.com/projects/ceph .. _`New issue`: http://tracker.ceph.com/projects/ceph/issues/new +.. _mailing-list: + Mailing list ------------ @@ -129,6 +131,7 @@ There are also `other Ceph-related mailing lists`_. .. _`other Ceph-related mailing lists`: https://ceph.com/irc/ +.. _irc: IRC --- @@ -141,6 +144,8 @@ time using `Internet Relay Chat`_. See ``https://ceph.com/irc/`` for how to set up your IRC client and a list of channels. +.. _submitting-patches: + Submitting patches ------------------ @@ -229,6 +234,8 @@ Kubernetes/Rook development cluster See :ref:`kubernetes-dev` +.. _backporting: + Backporting ----------- diff --git a/doc/dev/developer_guide/issue-tracker.rst b/doc/dev/developer_guide/issue-tracker.rst index e04c6e3e2df..eae68f3f06b 100644 --- a/doc/dev/developer_guide/issue-tracker.rst +++ b/doc/dev/developer_guide/issue-tracker.rst @@ -1,3 +1,5 @@ +.. _issue-tracker: + Issue Tracker ============= diff --git a/doc/dev/developer_guide/tests-integration-tests.rst b/doc/dev/developer_guide/tests-integration-tests.rst index f3fe002b0f8..4783a5c4c2b 100644 --- a/doc/dev/developer_guide/tests-integration-tests.rst +++ b/doc/dev/developer_guide/tests-integration-tests.rst @@ -1,3 +1,5 @@ +.. _testing-integration-tests: + Testing - Integration Tests =========================== @@ -96,7 +98,7 @@ all the integration tests, for all the Ceph components. `dummy `_ get a machine, do nothing and return success (commonly used to - verify the `integration testing`_ infrastructure works as expected) + verify the :ref:`testing-integration-tests` infrastructure works as expected) `fs `_ test CephFS mounted using FUSE