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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
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/

1 change: 1 addition & 0 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
40 changes: 25 additions & 15 deletions source/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <php-compatibility>`
page.
- Address any breaking changes between the library version
your application is using and your planned upgrade version in the
:ref:`Breaking Changes <php-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 <php-compat-changes>` section and the
:ref:`{+php-library+} Compatibility <php-compatibility>` page.

.. tip::

To ensure compatibility across {+mdb-server+} versions when
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -113,15 +115,23 @@ 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _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.
- 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 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