From 95227c0023aa811af06457ccefe26e267169e9f4 Mon Sep 17 00:00:00 2001
From: Stephanie Aurelio <stephanie.aurelio@mongodb.com>
Date: Thu, 12 Dec 2024 09:41:50 -0800
Subject: [PATCH 1/4] add whats new
---
source/index.txt | 10 ++++----
source/whats-new.txt | 60 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 65 insertions(+), 5 deletions(-)
create mode 100644 source/whats-new.txt
diff --git a/source/index.txt b/source/index.txt
index c696db05..03ba6f85 100644
--- a/source/index.txt
+++ b/source/index.txt
@@ -16,6 +16,7 @@
Connect </connect>
View the Source <https://github.com/mongodb/mongo-ruby-driver>
API Documentation <{+api-root+}>
+ What's New </whats-new>
.. TODO:
Databases & Collections </databases-collections>
@@ -27,7 +28,6 @@
Data Aggregation </aggregation>
Security </security>
Issues & Help </issues-and-help>
- What's New </whats-new>
Upgrade </upgrade>
Compatibility </compatibility>
@@ -89,11 +89,11 @@ working with data in the :ref:`ruby-get-started` tutorial.
.. Learn how to authenticate your application and encrypt your data in the
.. :ref:`ruby-security` section.
-.. What's New
-.. ----------
+What's New
+----------
-.. For a list of new features and changes in each version, see the :ref:`What's New <ruby-whats-new>`
-.. section.
+For a list of new features and changes in each version, see the :ref:`What's New <ruby-whats-new>`
+section.
.. Upgrade Driver Versions
.. -----------------------
diff --git a/source/whats-new.txt b/source/whats-new.txt
new file mode 100644
index 00000000..36958bea
--- /dev/null
+++ b/source/whats-new.txt
@@ -0,0 +1,60 @@
+.. _ruby-whats-new:
+
+==========
+What's New
+==========
+
+.. contents:: On this page
+ :local:
+ :backlinks: none
+ :depth: 1
+ :class: singlecol
+
+.. facet::
+ :name: genre
+ :values: reference
+
+.. meta::
+ :keywords: update, new feature, deprecation, upgrade
+
+Learn what's new in:
+
+* :ref:`2.21 <version-2.21>`
+* :ref:`2.20 <version-2.20>`
+
+.. _upcoming-breaking-changes:
+
+.. _version-2.21:
+
+What's New in 2.21
+------------------
+
+The {+driver-short+} 2.21 release includes the following new features:
+
+- Supports the Client-Side Operations Timeout (CSOT) feature, which unifies
+ most timeout-related options under a single ``timeout_ms`` option.
+- Supports {+mdb-server+} version 8.0.
+- Supports for range v2 queries with Queryable Encryption, including a new ``trim_factor``
+ parameter. For more information about Queryable Encryption, see :manual:`Queryable Encryption </core/queryable-encryption>`
+ in the {+mdb-server+} manual.
+
+.. _version-2.20:
+
+What's New in 2.21
+------------------
+
+The {+driver-short+} 2.20 release includes the following new features:
+
+- Discontinues support for Ruby 2.5 and 2.6. Deprecates support for Ruby 2.7 and
+ JRuby 9.2, which will be discontinued in the next minor driver version. Adds
+ support for JRuby 9.4.
+- Supports the newly-released Ruby-BSON version 5.0.
+- Allows connection strings without a slash between the hosts and the options.
+ For example, ``mongodb://example.com?w=1`` and ``mongodb://example.com/?w=1`` are
+ both valid connection strings now.
+- Sends container runtime and orchestration metadata for the client environment
+ to the server for analytics purposes.
+- Writes a warning message to the log when detecting the host as a CosmosDB
+ (Azure) or DocumentDB (Amazon) instance.
+- Attempts retries of read or write operations on a different mongos instance in
+ a sharded topology, if possible.
\ No newline at end of file
From 1f879e57dab0353751c76e7c3155939048e1caa3 Mon Sep 17 00:00:00 2001
From: Stephanie Aurelio <stephanie.aurelio@mongodb.com>
Date: Thu, 12 Dec 2024 13:16:33 -0800
Subject: [PATCH 2/4] edits
---
source/whats-new.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/source/whats-new.txt b/source/whats-new.txt
index 36958bea..6f0010ea 100644
--- a/source/whats-new.txt
+++ b/source/whats-new.txt
@@ -34,13 +34,13 @@ The {+driver-short+} 2.21 release includes the following new features:
- Supports the Client-Side Operations Timeout (CSOT) feature, which unifies
most timeout-related options under a single ``timeout_ms`` option.
- Supports {+mdb-server+} version 8.0.
-- Supports for range v2 queries with Queryable Encryption, including a new ``trim_factor``
+- Support for range v2 queries with Queryable Encryption, including a new ``trim_factor``
parameter. For more information about Queryable Encryption, see :manual:`Queryable Encryption </core/queryable-encryption>`
in the {+mdb-server+} manual.
.. _version-2.20:
-What's New in 2.21
+What's New in 2.20
------------------
The {+driver-short+} 2.20 release includes the following new features:
@@ -50,7 +50,7 @@ The {+driver-short+} 2.20 release includes the following new features:
support for JRuby 9.4.
- Supports the newly-released Ruby-BSON version 5.0.
- Allows connection strings without a slash between the hosts and the options.
- For example, ``mongodb://example.com?w=1`` and ``mongodb://example.com/?w=1`` are
+ For example, "mongodb://example.com?w=1" and "mongodb://example.com/?w=1" are
both valid connection strings now.
- Sends container runtime and orchestration metadata for the client environment
to the server for analytics purposes.
From 0c656d9cdbab5f6479e210a3258eb8be013302df Mon Sep 17 00:00:00 2001
From: Stephanie Aurelio <stephanie.aurelio@mongodb.com>
Date: Fri, 13 Dec 2024 14:47:24 -0800
Subject: [PATCH 3/4] LM feedback
---
source/whats-new.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/source/whats-new.txt b/source/whats-new.txt
index 6f0010ea..deced2d0 100644
--- a/source/whats-new.txt
+++ b/source/whats-new.txt
@@ -50,11 +50,11 @@ The {+driver-short+} 2.20 release includes the following new features:
support for JRuby 9.4.
- Supports the newly-released Ruby-BSON version 5.0.
- Allows connection strings without a slash between the hosts and the options.
- For example, "mongodb://example.com?w=1" and "mongodb://example.com/?w=1" are
+ For example, ``mongodb://example.com?w=1`` and ``mongodb://example.com/?w=1`` are
both valid connection strings now.
- Sends container runtime and orchestration metadata for the client environment
to the server for analytics purposes.
- Writes a warning message to the log when detecting the host as a CosmosDB
(Azure) or DocumentDB (Amazon) instance.
-- Attempts retries of read or write operations on a different mongos instance in
- a sharded topology, if possible.
\ No newline at end of file
+- Attempts retries of read or write operations on a different ``mongos``
+ instance in a sharded topology, if possible.
\ No newline at end of file
From a6f7674c8244be23c3a9649d102eda29c811ba15 Mon Sep 17 00:00:00 2001
From: Stephanie Aurelio <stephanie.aurelio@mongodb.com>
Date: Tue, 17 Dec 2024 10:16:38 -0800
Subject: [PATCH 4/4] add release note link
---
source/whats-new.txt | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/source/whats-new.txt b/source/whats-new.txt
index deced2d0..caf13a4f 100644
--- a/source/whats-new.txt
+++ b/source/whats-new.txt
@@ -38,6 +38,10 @@ The {+driver-short+} 2.21 release includes the following new features:
parameter. For more information about Queryable Encryption, see :manual:`Queryable Encryption </core/queryable-encryption>`
in the {+mdb-server+} manual.
+To learn more about this release, see the
+:github:`v2.21 Release Notes <mongodb/mongo-ruby-driver/releases/tag/v2.21.0>` on
+GitHub.
+
.. _version-2.20:
What's New in 2.20
@@ -57,4 +61,8 @@ The {+driver-short+} 2.20 release includes the following new features:
- Writes a warning message to the log when detecting the host as a CosmosDB
(Azure) or DocumentDB (Amazon) instance.
- Attempts retries of read or write operations on a different ``mongos``
- instance in a sharded topology, if possible.
\ No newline at end of file
+ instance in a sharded topology, if possible.
+
+To learn more about this release, see the
+:github:`v2.20 Release Notes <mongodb/mongo-ruby-driver/releases/tag/v2.20.0>` on
+GitHub.
\ No newline at end of file