From d3eadbf59c0dbc76ad23a0ba12bfb2eff6d896c6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 30 Aug 2023 18:57:00 +0000 Subject: [PATCH] fix(docs): fix more broken links still pointing to .rst files [backport 1.18] (#6797) Backport 599ac2eb00589ca8375ce3871ccf9d6cb1034f19 from #6790 to 1.18. ## Motivation The docs still point to some `.rst` files, causing a 404 as mentioned in [this issue](https://github.com/DataDog/dd-trace-py/issues/6788) ## Checklist - [X] Change(s) are motivated and described in the PR description. - [X] Testing strategy is described if automated tests are not included in the PR. - [X] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [X] Change is maintainable (easy to change, telemetry, documentation). - [X] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [X] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [X] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that. Co-authored-by: Eric Navarro --- docs/contributing-integrations.rst | 4 +++- docs/contributing-testing.rst | 2 ++ docs/contributing.rst | 6 ++++-- docs/releasenotes.rst | 2 +- 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/contributing-integrations.rst b/docs/contributing-integrations.rst index 882731c886e..8904da950e4 100644 --- a/docs/contributing-integrations.rst +++ b/docs/contributing-integrations.rst @@ -1,3 +1,5 @@ +.. _integration_guidelines: + =========================== How To Write an Integration =========================== @@ -29,7 +31,7 @@ Your development process might look like this: - Write the integration (see more on this below). - - Open a `pull request `_ containing your changes. + - Open a :ref:`pull request` containing your changes. All integrations live in ``ddtrace/contrib/`` and contain at least two files, ``__init__.py`` and ``patch.py``. A skeleton integration is available under diff --git a/docs/contributing-testing.rst b/docs/contributing-testing.rst index f5dbbb95cd5..488e65e74ea 100644 --- a/docs/contributing-testing.rst +++ b/docs/contributing-testing.rst @@ -1,3 +1,5 @@ +.. _testing_guidelines: + Testing ======= diff --git a/docs/contributing.rst b/docs/contributing.rst index 489b60a455b..13e45012ec2 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -15,6 +15,8 @@ and `docker-compose `_. Thanks for working with us! +.. _change_process: + Change Process ============== @@ -99,7 +101,7 @@ Tests ----- If your change touches Python code, it should probably include at least one test. See the -`testing guidelines `_ for details. +:ref:`testing guidelines` for details. Documentation ------------- @@ -107,7 +109,7 @@ Documentation Pull requests implementing new features should include documentation for those features. The audience for this documentation is the public population of library users. The Products and Core logic are documented alongside this document, in the ``docs`` directory. The documentation for each Integration is contained in a docstring -in that integration's ``__init__.py`` file. See `this page `_ for more information +in that integration's ``__init__.py`` file. See :ref:`this page` for more information on writing documentation for Integrations. Logging diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst index 207374c1656..f51908fd202 100644 --- a/docs/releasenotes.rst +++ b/docs/releasenotes.rst @@ -11,7 +11,7 @@ with the library. A release note is **required** if a PR is user-impacting, or if it meets any of the following conditions: -* `Breaking change to the public API `_ +* :ref:`Breaking change to the public API` * New feature * Bug fix * Deprecations