From 15d9fc306f38c20915cb2b6dce5a939592d896b5 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 7 May 2025 16:58:43 -0400 Subject: [PATCH 1/5] DOCSP-48100: Consolidate 2.x versions --- config/redirects | 8 ++++++-- source/upgrade.txt | 14 +++++++------- 2 files changed, 13 insertions(+), 9 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..6d3fed61 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 6dfc4d29508124635d5f4f1b82eedda8c0d4227f Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 7 May 2025 17:01:01 -0400 Subject: [PATCH 2/5] revert redirects --- config/redirects | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/config/redirects b/config/redirects index 947ff49a..d437be97 100644 --- a/config/redirects +++ b/config/redirects @@ -1,14 +1,10 @@ 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 v1.x v2.0 v2.x master +define: versions v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v2.0 master symlink: upcoming -> master -symlink: current -> v2.x - -# consolidation redirects -[*-v1.21]: ${prefix}/${version}/ -> ${base}/v1.x/ -[v2.0]: ${prefix}/${version}/ -> ${base}/v2.x/ +symlink: current -> v2.0 # general redirects [v1.17-v1.19]: ${prefix}/${version}/tutorial/client-side-encryption/ -> ${base}/${version}/tutorial/encryption/ From 7cd15355108783b20325cb162a1d8ea17e8cb365 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 10:54:56 -0400 Subject: [PATCH 3/5] edits --- snooty.toml | 1 + source/upgrade.txt | 32 +++++++++++++++++++++----------- 2 files changed, 22 insertions(+), 11 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 6d3fed61..2a747382 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 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 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,10 +115,18 @@ 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 From d0230956b4023d169d21d172e4ee90d666343f7b Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 11:09:11 -0400 Subject: [PATCH 4/5] stage From 2861003284dee071518ac035c12831ef0d296b13 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 11:11:01 -0400 Subject: [PATCH 5/5] word --- source/upgrade.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index 2a747382..5c0c8fe8 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -132,6 +132,6 @@ This library version introduces the following compatibility changes: .. 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 `__.