Skip to content

DOCSP-48100: Consolidate minor versions #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 15, 2025
Merged

DOCSP-48100: Consolidate minor versions #240

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
035d5dc
DOCSP-48100: Consolidate minor versions
norareidy May 7, 2025
ae6be88
edits
norareidy May 7, 2025
0f0f1ed
remove old redirects
norareidy May 7, 2025
7c37037
AB feedback
norareidy May 9, 2025
62f8cca
edit
norareidy May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 10 additions & 26 deletions config/redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
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/
[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}/

# 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/
Expand All @@ -34,23 +38,3 @@ symlink: current -> v2.0
[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/

16 changes: 8 additions & 8 deletions source/upgrade.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, it makes sense to call these out as breaking changes in 2.0 - people will understand that these apply to future 2.x versions as well. This helps clarify that we don't make breaking changes in minor versions.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed! I also added a sentence in the "Breaking Changes" introduction noting that only major version releases have breaking changes

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This library version introduces the following breaking changes:
Expand All @@ -113,15 +113,15 @@ This library version introduces the following breaking changes:
methods, you can register a :php:`CommandSubscriber
<mongodb-driver-monitoring-commandsubscriber>` in your application.

Version 1.20 Breaking Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Version 1.x Breaking Changes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Version 1.x Breaking Changes
Version 1.x Compatibility Changes

We don't consider bumping dependencies such as minimum PHP or server versions as "breaking changes", as that would require us to only do these in a major version. The rationale is that for PHP versions, the compatibility is checked by composer, so users on a version of PHP that is no longer supported won't be upgraded to the newer driver version and thus don't encounter a breaking change. Since the server version drops are so far behind (one year after it's marked EOL by the server team), the number of people affected is fairly low. For example, we're only now dropping support for MongoDB 4.0.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see; I moved the compatibility changes to its own section to separate it from the 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 <https://github.com/mongodb/mongo-php-library/releases>`__.
To view breaking changes for {+php-library+} versions 1.19 and earlier, see the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
<https://github.com/mongodb/mongo-php-library/releases>`__.
Loading