From 035d5dc389a8cb1524c841d340092d42296d8e6b Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 7 May 2025 17:03:21 -0400 Subject: [PATCH 1/5] DOCSP-48100: Consolidate minor versions --- config/redirects | 8 ++++++-- source/upgrade.txt | 16 ++++++++-------- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/config/redirects b/config/redirects index d437be97..947ff49a 100644 --- a/config/redirects +++ b/config/redirects @@ -1,10 +1,14 @@ define: base https://www.mongodb.com/docs/php-library define: prefix docs/php-library raw: ${prefix}/ -> ${base}/current -define: versions v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v2.0 master +define: versions v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v1.x v2.0 v2.x master symlink: upcoming -> master -symlink: current -> v2.0 +symlink: current -> v2.x + +# consolidation redirects +[*-v1.21]: ${prefix}/${version}/ -> ${base}/v1.x/ +[v2.0]: ${prefix}/${version}/ -> ${base}/v2.x/ # general redirects [v1.17-v1.19]: ${prefix}/${version}/tutorial/client-side-encryption/ -> ${base}/${version}/tutorial/encryption/ diff --git a/source/upgrade.txt b/source/upgrade.txt index c37fc106..c0021f2b 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -90,7 +90,7 @@ associated JIRA tickets for each release on `GitHub .. _php-v2-breaking-changes: -Version 2.0 Breaking Changes +Version 2.x Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This library version introduces the following breaking changes: @@ -113,15 +113,15 @@ This library version introduces the following breaking changes: methods, you can register a :php:`CommandSubscriber ` in your application. -Version 1.20 Breaking Changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Version 1.x Breaking Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This library version introduces the following breaking changes: -- Drops support for {+mdb-server+} 3.6. +- Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20 -Version 1.19 and Earlier -~~~~~~~~~~~~~~~~~~~~~~~~ +.. tip:: Earlier Library Versions -For library versions 1.19 and earlier, see the release notes and associated -JIRA tickets for each release on `GitHub `__. + To view breaking changes for {+php-library+} versions 1.19 and earlier, see the + release notes and associated JIRA tickets for each release on `GitHub + `__. From ae6be88fa59df62383aae8794cce33ab148a74c3 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 7 May 2025 17:23:11 -0400 Subject: [PATCH 2/5] edits --- config/redirects | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/config/redirects b/config/redirects index 947ff49a..d57892f4 100644 --- a/config/redirects +++ b/config/redirects @@ -11,9 +11,9 @@ symlink: current -> v2.x [v2.0]: ${prefix}/${version}/ -> ${base}/v2.x/ # general redirects -[v1.17-v1.19]: ${prefix}/${version}/tutorial/client-side-encryption/ -> ${base}/${version}/tutorial/encryption/ -[v1.16]: ${prefix}/${version}/tutorial/encryption/ -> ${base}/${version}/ -[v1.20-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/run-sample-query/ +[v1.17-v1.19]: ${prefix}/${version}/tutorial/client-side-encryption/ -> ${base}/${version}/security/in-use-encryption/ +[v1.16]: ${prefix}/${version}/tutorial/encryption/ -> ${base}/${version}/security/in-use-encryption/ +[v1.20-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/#run-a-sample-query/ [*-v1.20]: ${prefix}/${version}/aggregation/atlas-search -> ${base}/${version}/aggregation/ [*-v1.20]: ${prefix}/${version}/aggregation/vector-search -> ${base}/${version}/aggregation/ [*-v1.20]: ${prefix}/${version}/builders -> ${base}/${version}/ @@ -21,7 +21,7 @@ symlink: current -> v2.x # standardization redirects # redirects in standardized docs -[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/download-and-install/ +[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/ [v1.20-*]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/${version}/connect/ [v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring/cluster-monitoring/ [v1.20-*]: ${prefix}/${version}/tutorial/crud/ -> ${base}/${version}/read/ From 0f0f1ed4b5aee6d59e054194cecc4bd40f5f0229 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 7 May 2025 17:27:36 -0400 Subject: [PATCH 3/5] remove old redirects --- config/redirects | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/config/redirects b/config/redirects index d57892f4..a747c57b 100644 --- a/config/redirects +++ b/config/redirects @@ -38,23 +38,3 @@ symlink: current -> v2.x [v1.20-*]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/${version}/data-formats/modeling-bson-data/ [v1.20-*]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/${version}/stable-api/ [v1.20-*]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/${version}/aws-lambda/ - -# redirects in old docs -# note: this mapping does not account for all of the new pages -[*-v1.19]: ${prefix}/${version}/get-started/download-and-install/ -> ${base}/${version}/tutorial/install-php-library/ -[*-v1.19]: ${prefix}/${version}/connect/ -> ${base}/${version}/tutorial/connecting/ -[*-v1.19]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/tutorial/server-selection/ -[*-v1.19]: ${prefix}/${version}/read/ -> ${base}/${version}/tutorial/crud/ -[*-v1.19]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/tutorial/codecs/ -[*-v1.19]: ${prefix}/${version}/run-command/ -> ${base}/${version}/tutorial/commands/ -[*-v1.19]: ${prefix}/${version}/data-formats/custom-types/ -> ${base}/${version}/tutorial/custom-types/ -[*-v1.19]: ${prefix}/${version}/data-formats/decimal128/ -> ${base}/${version}/tutorial/decimal128/ -[*-v1.19]: ${prefix}/${version}/security/in-use-encryption/ -> ${base}/${version}/tutorial/encryption/ -[*-v1.19]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/tutorial/gridfs/ -[*-v1.19]: ${prefix}/${version}/indexes/ -> ${base}/${version}/tutorial/indexes/ -[*-v1.19]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/tutorial/tailable-cursor/ -[*-v1.19]: ${prefix}/${version}/data-formats/modeling-bson-data/ -> ${base}/${version}/tutorial/modeling-bson-data/ -[*-v1.19]: ${prefix}/${version}/stable-api/ -> ${base}/${version}/tutorial/stable-api/ -[*-v1.19]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/ -[*-v1.19]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/tutorial/aws-lambda/ - From 7c37037c019fc3af7383d77e7423c50d6c3fc7b4 Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 9 May 2025 11:45:26 -0400 Subject: [PATCH 4/5] AB feedback --- snooty.toml | 1 + source/upgrade.txt | 34 ++++++++++++++++++++++------------ 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/snooty.toml b/snooty.toml index 50630236..0d6dfcc0 100644 --- a/snooty.toml +++ b/snooty.toml @@ -50,3 +50,4 @@ api = "https://www.mongodb.com/docs/php-library/current/reference" string-data-type = "``string``" bool-data-type = "``bool``" int-data-type = "``int``" +language = "PHP" diff --git a/source/upgrade.txt b/source/upgrade.txt index c0021f2b..67486d4b 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -30,15 +30,16 @@ How to Upgrade Before you upgrade, perform the following actions: -- Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions - your application connects to and the PHP version your - application compiles with. For version compatibility information, see the - :ref:`{+php-library+} Compatibility ` - page. - Address any breaking changes between the library version your application is using and your planned upgrade version in the :ref:`Breaking Changes ` section. +- Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions + your application connects to and the PHP version your + application compiles with. For version compatibility information, see the + :ref:`Compatibility Changes ` section and the + :ref:`{+php-library+} Compatibility ` page. + .. tip:: To ensure compatibility across {+mdb-server+} versions when @@ -81,8 +82,9 @@ application from working properly if not addressed before upgrading the library. The breaking changes in this section are categorized by the library -version that introduced them. When upgrading library versions, address -all the breaking changes between the current and upgrade versions. +version that introduced them. Only major driver versions introduce +breaking changes. When upgrading library versions, address all +the breaking changes between the current and upgrade versions. For more information on release changes, see the release notes and associated JIRA tickets for each release on `GitHub @@ -90,7 +92,7 @@ associated JIRA tickets for each release on `GitHub .. _php-v2-breaking-changes: -Version 2.x Breaking Changes +Version 2.0 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This library version introduces the following breaking changes: @@ -113,15 +115,23 @@ This library version introduces the following breaking changes: methods, you can register a :php:`CommandSubscriber ` in your application. -Version 1.x Breaking Changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. _php-compat-changes: -This library version introduces the following breaking changes: +Compatibility Changes +--------------------- + +This section describes the {+mdb-server+} and {+language+} compatibility +changes introduced in {+php-library+} version releases. + +Version 1.x Compatibility Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This library version introduces the following compatibility changes: - Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20 .. tip:: Earlier Library Versions - To view breaking changes for {+php-library+} versions 1.19 and earlier, see the + To view compatibility changes for {+php-library+} versions 1.19 and earlier, see the release notes and associated JIRA tickets for each release on `GitHub `__. From 62f8cca24369c19e956bc3145c25187f29233a88 Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 9 May 2025 11:47:27 -0400 Subject: [PATCH 5/5] edit --- source/upgrade.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index 67486d4b..5c0c8fe8 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -82,8 +82,8 @@ application from working properly if not addressed before upgrading the library. The breaking changes in this section are categorized by the library -version that introduced them. Only major driver versions introduce -breaking changes. When upgrading library versions, address all +version that introduced them. Only major library versions introduce +breaking changes. When upgrading versions, address all the breaking changes between the current and upgrade versions. For more information on release changes, see the release notes and