Skip to content

Commit c5d75cd

Browse files
authored
docs: update versioning docs (#13269)
Remove duplicate content that will be migrated to the public docs. PR to update the public docs: DataDog/documentation#28968 ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - 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)
1 parent 2765836 commit c5d75cd

File tree

3 files changed

+3
-112
lines changed

3 files changed

+3
-112
lines changed

docs/contributing.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ At this time, do not use the merge queue option.
5959
Backporting
6060
-----------
6161

62-
Each minor version has its own branch. Bug fixes are "backported" from trunk to certain
63-
minor version branches according to the :ref:`version support policy<versioning_release>`.
62+
Each minor version has its own branch.
6463

6564
* **Fix PRs** are backported to all maintained release branches.
6665
* **CI PRs** are backported to the maintained release branches.

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-
* :ref:`Breaking change to the public API<versioning_release>`
14+
* Breaking change to the public API
1515
* New feature
1616
* Bug fix
1717
* Deprecations

docs/versioning.rst

Lines changed: 1 addition & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -6,70 +6,7 @@ Versioning
66

77
Release support
88
===============
9-
10-
.. list-table::
11-
:header-rows: 1
12-
13-
* - Release
14-
- :ref:`Support level<versioning_support_levels>`
15-
- Minimum Datadog Agent
16-
* - ``<2``
17-
- :ref:`End of Life<versioning_support_eol>`
18-
-
19-
* - ``>=2.0,<3``
20-
- :ref:`Maintenance<versioning_support_maintenance>`
21-
- 7.28
22-
* - ``>=3.0,<4``
23-
- :ref:`General Availability<versioning_support_ga>`
24-
- 7.28
25-
26-
.. _versioning_support_levels:
27-
28-
Support levels
29-
==============
30-
31-
.. list-table::
32-
:header-rows: 1
33-
34-
* - Level
35-
- Policy
36-
37-
.. _versioning_support_ga:
38-
* - General Availability (GA)
39-
- Bug fixes are released on the most recent General Availability minor release line. New features are released periodically
40-
as minor version changes. Critical fixes are backported to the three most recent minor release lines.
41-
42-
.. _versioning_support_maintenance:
43-
* - Maintenance
44-
- The most recent Maintenance minor release line receives critical fixes.
45-
46-
.. _versioning_support_eol:
47-
* - End-of-Life (EOL)
48-
- Receives no updates or support
49-
50-
.. _versioning_release:
51-
52-
Release versions
53-
================
54-
55-
The non-negative integer components of the **version format** (``v<MAJOR>.<MINOR>.<PATCH>``) are incremented by the criteria:
56-
57-
MAJOR
58-
Incompatible changes to the public :ref:`interface<versioning_interfaces>`
59-
60-
Removing support for a :ref:`runtime<versioning_supported_runtimes>`.
61-
62-
MINOR
63-
Backwards compatible changes to the public :ref:`interface<versioning_interfaces>`
64-
65-
Any backwards compatible or incompatible changes to the internal :ref:`interface<versioning_interfaces>`
66-
67-
Adding support for a :ref:`runtime<versioning_supported_runtimes>`
68-
69-
PATCH
70-
Bug fixes that are backwards compatible
71-
72-
Security fixes that are backwards compatible
9+
See our public documentation for versioning information. `public documentation <https://docs.datadoghq.com/tracing/trace_collection/compatibility/python/#releases>`_
7310

7411
.. _versioning_interfaces:
7512

@@ -92,48 +29,3 @@ The definition of the **internal** interface:
9229
Any module, function, class or attribute that is contained within an internal module is internal
9330

9431
Internal code may be subject to breaking changes in bug fix and minor releases.
95-
96-
.. _versioning_supported_runtimes:
97-
98-
Supported runtimes
99-
==================
100-
101-
102-
.. list-table::
103-
:header-rows: 1
104-
105-
* - OS
106-
- CPU
107-
- Runtime
108-
- Runtime version
109-
- Supported Release
110-
* - Linux
111-
- x86-64, i686, AArch64
112-
- CPython
113-
- 3.7-3.13
114-
- ``>=2.0,<3``
115-
* - MacOS
116-
- Intel, Apple Silicon
117-
- CPython
118-
- 3.7-3.13
119-
- ``>=2.0,<3``
120-
* - Windows
121-
- 64bit, 32bit
122-
- CPython
123-
- 3.7-3.13
124-
- ``>=2.0,<3``
125-
* - Linux
126-
- x86-64, i686, AArch64
127-
- CPython
128-
- 2.7, 3.5-3.11
129-
- ``>=1.0,<2``
130-
* - MacOS
131-
- Intel, Apple Silicon
132-
- CPython
133-
- 2.7, 3.5-3.11
134-
- ``>=1.0,<2``
135-
* - Windows
136-
- 64bit, 32bit
137-
- CPython
138-
- 2.7, 3.5-3.11
139-
- ``>=1.0,<2``

0 commit comments

Comments
 (0)