Skip to content

DOCSP-45210 What's New #99

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
Dec 17, 2024
Merged

DOCSP-45210 What's New #99

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
95227c0
add whats new
stephmarie17 Dec 12, 2024
1f879e5
edits
stephmarie17 Dec 12, 2024
8073558
Merge branch 'standardization' into docsp-45210-whats-new
stephmarie17 Dec 13, 2024
0c656d9
LM feedback
stephmarie17 Dec 13, 2024
a6f7674
add release note link
stephmarie17 Dec 17, 2024
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
10 changes: 5 additions & 5 deletions source/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
Read Data </read>
View the Source <https://github.com/mongodb/mongo-ruby-driver>
API Documentation <{+api-root+}>
What's New </whats-new>
Compatibility </compatibility>

.. TODO:
Expand All @@ -28,7 +29,6 @@
Data Aggregation </aggregation>
Security </security>
Issues & Help </issues-and-help>
What's New </whats-new>
Upgrade </upgrade>

Introduction
Expand Down Expand Up @@ -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
.. -----------------------
Expand Down
60 changes: 60 additions & 0 deletions source/whats-new.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
- 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

[question for technical reviewer] Does your team also want to link to driver release notes for each version at the end of the summary? Not all "What's New" pages do this but I noticed to the current docs page links out so wanted to verify the preference of the team.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See the Node What's New docs as an example of where the link would go.

Copy link
Contributor

Choose a reason for hiding this comment

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

Linking to the specific versions might be most convenient for the user, if that's not too much trouble for the docs team.

@alexbevi might have some thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's no trouble 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the PR with the links in case @alexbevi wants to take a look and lmk if that looks good to go.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like the links to the GH release. LGTM

.. _version-2.20:

What's New in 2.20
------------------

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.
Loading