Skip to content

Commit 365be65

Browse files
authored
DOCSP-48100: Consolidate 2.x versions (#239)
* DOCSP-48100: Consolidate 2.x versions * revert redirects * edits * stage * word
1 parent b247139 commit 365be65

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,4 @@ api = "https://www.mongodb.com/docs/php-library/current/reference"
5050
string-data-type = "``string``"
5151
bool-data-type = "``bool``"
5252
int-data-type = "``int``"
53+
language = "PHP"

source/upgrade.txt

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,16 @@ How to Upgrade
3030

3131
Before you upgrade, perform the following actions:
3232

33-
- Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions
34-
your application connects to and the PHP version your
35-
application compiles with. For version compatibility information, see the
36-
:ref:`{+php-library+} Compatibility <php-compatibility>`
37-
page.
3833
- Address any breaking changes between the library version
3934
your application is using and your planned upgrade version in the
4035
:ref:`Breaking Changes <php-breaking-changes>` section.
4136

37+
- Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions
38+
your application connects to and the PHP version your
39+
application compiles with. For version compatibility information, see the
40+
:ref:`Compatibility Changes <php-compat-changes>` section and the
41+
:ref:`{+php-library+} Compatibility <php-compatibility>` page.
42+
4243
.. tip::
4344

4445
To ensure compatibility across {+mdb-server+} versions when
@@ -81,8 +82,9 @@ application from working properly if not addressed before upgrading the
8182
library.
8283

8384
The breaking changes in this section are categorized by the library
84-
version that introduced them. When upgrading library versions, address
85-
all the breaking changes between the current and upgrade versions.
85+
version that introduced them. Only major library versions introduce
86+
breaking changes. When upgrading versions, address all
87+
the breaking changes between the current and upgrade versions.
8688

8789
For more information on release changes, see the release notes and
8890
associated JIRA tickets for each release on `GitHub
@@ -113,15 +115,23 @@ This library version introduces the following breaking changes:
113115
methods, you can register a :php:`CommandSubscriber
114116
<mongodb-driver-monitoring-commandsubscriber>` in your application.
115117

116-
Version 1.20 Breaking Changes
117-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118+
.. _php-compat-changes:
118119

119-
This library version introduces the following breaking changes:
120+
Compatibility Changes
121+
---------------------
122+
123+
This section describes the {+mdb-server+} and {+language+} compatibility
124+
changes introduced in {+php-library+} version releases.
125+
126+
Version 1.x Compatibility Changes
127+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128+
129+
This library version introduces the following compatibility changes:
120130

121-
- Drops support for {+mdb-server+} 3.6.
131+
- Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20
122132

123-
Version 1.19 and Earlier
124-
~~~~~~~~~~~~~~~~~~~~~~~~
133+
.. tip:: Earlier Library Versions
125134

126-
For library versions 1.19 and earlier, see the release notes and associated
127-
JIRA tickets for each release on `GitHub <https://github.com/mongodb/mongo-php-library/releases>`__.
135+
To view compatibility changes for {+php-library+} versions 1.19 and earlier, see the
136+
release notes and associated JIRA tickets for each release on `GitHub
137+
<https://github.com/mongodb/mongo-php-library/releases>`__.

0 commit comments

Comments
 (0)