Skip to content

Commit d84ef0a

Browse files
norareidynorareidy
authored
DOCSP-48100: Consolidate minor versions (#240)
* DOCSP-48100: Consolidate minor versions * edits * remove old redirects * AB feedback * edit
1 parent ffdd49c commit d84ef0a

File tree

3 files changed

+36
-41
lines changed

3 files changed

+36
-41
lines changed

‎config/redirects‎

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
define: base https://www.mongodb.com/docs/php-library
22
define: prefix docs/php-library
33
raw: ${prefix}/ -> ${base}/current
4-
define: versions v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v2.0 master
4+
define: versions v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v1.x v2.0 v2.x master
55

66
symlink: upcoming -> master
7-
symlink: current -> v2.0
7+
symlink: current -> v2.x
8+
9+
# consolidation redirects
10+
[*-v1.21]: ${prefix}/${version}/ -> ${base}/v1.x/
11+
[v2.0]: ${prefix}/${version}/ -> ${base}/v2.x/
812

913
# general redirects
10-
[v1.17-v1.19]: ${prefix}/${version}/tutorial/client-side-encryption/ -> ${base}/${version}/tutorial/encryption/
11-
[v1.16]: ${prefix}/${version}/tutorial/encryption/ -> ${base}/${version}/
12-
[v1.20-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/run-sample-query/
14+
[v1.17-v1.19]: ${prefix}/${version}/tutorial/client-side-encryption/ -> ${base}/${version}/security/in-use-encryption/
15+
[v1.16]: ${prefix}/${version}/tutorial/encryption/ -> ${base}/${version}/security/in-use-encryption/
16+
[v1.20-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/#run-a-sample-query/
1317
[*-v1.20]: ${prefix}/${version}/aggregation/atlas-search -> ${base}/${version}/aggregation/
1418
[*-v1.20]: ${prefix}/${version}/aggregation/vector-search -> ${base}/${version}/aggregation/
1519
[*-v1.20]: ${prefix}/${version}/builders -> ${base}/${version}/
1620

1721
# standardization redirects
1822

1923
# redirects in standardized docs
20-
[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/download-and-install/
24+
[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/
2125
[v1.20-*]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/${version}/connect/
2226
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring/cluster-monitoring/
2327
[v1.20-*]: ${prefix}/${version}/tutorial/crud/ -> ${base}/${version}/read/
@@ -34,23 +38,3 @@ symlink: current -> v2.0
3438
[v1.20-*]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/${version}/data-formats/modeling-bson-data/
3539
[v1.20-*]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/${version}/stable-api/
3640
[v1.20-*]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/${version}/aws-lambda/
37-
38-
# redirects in old docs
39-
# note: this mapping does not account for all of the new pages
40-
[*-v1.19]: ${prefix}/${version}/get-started/download-and-install/ -> ${base}/${version}/tutorial/install-php-library/
41-
[*-v1.19]: ${prefix}/${version}/connect/ -> ${base}/${version}/tutorial/connecting/
42-
[*-v1.19]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/tutorial/server-selection/
43-
[*-v1.19]: ${prefix}/${version}/read/ -> ${base}/${version}/tutorial/crud/
44-
[*-v1.19]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/tutorial/codecs/
45-
[*-v1.19]: ${prefix}/${version}/run-command/ -> ${base}/${version}/tutorial/commands/
46-
[*-v1.19]: ${prefix}/${version}/data-formats/custom-types/ -> ${base}/${version}/tutorial/custom-types/
47-
[*-v1.19]: ${prefix}/${version}/data-formats/decimal128/ -> ${base}/${version}/tutorial/decimal128/
48-
[*-v1.19]: ${prefix}/${version}/security/in-use-encryption/ -> ${base}/${version}/tutorial/encryption/
49-
[*-v1.19]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/tutorial/gridfs/
50-
[*-v1.19]: ${prefix}/${version}/indexes/ -> ${base}/${version}/tutorial/indexes/
51-
[*-v1.19]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/tutorial/tailable-cursor/
52-
[*-v1.19]: ${prefix}/${version}/data-formats/modeling-bson-data/ -> ${base}/${version}/tutorial/modeling-bson-data/
53-
[*-v1.19]: ${prefix}/${version}/stable-api/ -> ${base}/${version}/tutorial/stable-api/
54-
[*-v1.19]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/
55-
[*-v1.19]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/tutorial/aws-lambda/
56-

‎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)