Skip to content

Commit d3eadbf

Browse files
fix(docs): fix more broken links still pointing to .rst files [backport 1.18] (#6797)
Backport 599ac2e from #6790 to 1.18. ## Motivation The docs still point to some `.rst` files, causing a 404 as mentioned in [this issue](#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 <[email protected]>
1 parent 9da3ba2 commit d3eadbf

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

docs/contributing-integrations.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _integration_guidelines:
2+
13
===========================
24
How To Write an Integration
35
===========================
@@ -29,7 +31,7 @@ Your development process might look like this:
2931

3032
- Write the integration (see more on this below).
3133

32-
- Open a `pull request <contributing.rst#change-process>`_ containing your changes.
34+
- Open a :ref:`pull request<change_process>` containing your changes.
3335

3436
All integrations live in ``ddtrace/contrib/`` and contain at least two files,
3537
``__init__.py`` and ``patch.py``. A skeleton integration is available under

docs/contributing-testing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _testing_guidelines:
2+
13
Testing
24
=======
35

docs/contributing.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ and `docker-compose <https://www.docker.com/products/docker-compose>`_.
1515

1616
Thanks for working with us!
1717

18+
.. _change_process:
19+
1820
Change Process
1921
==============
2022

@@ -99,15 +101,15 @@ Tests
99101
-----
100102

101103
If your change touches Python code, it should probably include at least one test. See the
102-
`testing guidelines <contributing-testing.rst>`_ for details.
104+
:ref:`testing guidelines<testing_guidelines>` for details.
103105

104106
Documentation
105107
-------------
106108

107109
Pull requests implementing new features should include documentation for those features. The audience for this
108110
documentation is the public population of library users. The Products and Core logic are documented alongside
109111
this document, in the ``docs`` directory. The documentation for each Integration is contained in a docstring
110-
in that integration's ``__init__.py`` file. See `this page <contributing-integrations.rst>`_ for more information
112+
in that integration's ``__init__.py`` file. See :ref:`this page<integration_guidelines>` for more information
111113
on writing documentation for Integrations.
112114

113115
Logging

docs/releasenotes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ with the library.
1111

1212
A release note is **required** if a PR is user-impacting, or if it meets any of the following conditions:
1313

14-
* `Breaking change to the public API <versioning.rst#release-versions>`_
14+
* :ref:`Breaking change to the public API<versioning_release>`
1515
* New feature
1616
* Bug fix
1717
* Deprecations

0 commit comments

Comments
 (0)