From 9f3579990e49a0fc36e0e467c59873fc42799b3f Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 3 Sep 2024 10:12:55 -0500 Subject: [PATCH 1/3] v3.1 bump --- config/redirects | 2 +- snooty.toml | 19 ++++++++++--------- source/whats-new.txt | 25 +++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 10 deletions(-) diff --git a/config/redirects b/config/redirects index 28d9091c..843fe7b7 100644 --- a/config/redirects +++ b/config/redirects @@ -1,6 +1,6 @@ define: prefix docs/drivers/rust define: base https://www.mongodb.com/${prefix} -define: versions v2.7 v2.8 v3.0 master +define: versions v2.7 v2.8 v3.0 v3.1 master symlink: current -> master diff --git a/snooty.toml b/snooty.toml index f483dad0..02044c5e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -1,18 +1,19 @@ name = "rust" title = "Rust Driver" -intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv", - "https://www.mongodb.com/docs/drivers/objects.inv", - "https://www.mongodb.com/docs/atlas/objects.inv" - ] +intersphinx = [ + "https://www.mongodb.com/docs/manual/objects.inv", + "https://www.mongodb.com/docs/drivers/objects.inv", + "https://www.mongodb.com/docs/atlas/objects.inv", +] toc_landing_pages = [ "/quick-start", "/fundamentals/connections", "/fundamentals/crud", "/usage-examples", - "/fundamentals/indexes" - ] + "/fundamentals/indexes", +] sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" @@ -20,9 +21,9 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver-long = "MongoDB Rust Driver" driver-short = "Rust driver" server = "MongoDB Server" -docs-branch = "master" # always set this to the docs branch (i.e. master, v2.6, v2.5, etc.) -version = "3.0.1" # always set this to the driver version (i.e. 2.6.0, 2.5.0, etc.) -min-rust-version = "1.60" # always set this to the minimum supported Rust version +docs-branch = "master" # always set this to the docs branch (i.e. master, v2.6, v2.5, etc.) +version = "3.1.0" # always set this to the driver version (i.e. 2.6.0, 2.5.0, etc.) +min-rust-version = "1.60" # always set this to the minimum supported Rust version api = "https://docs.rs/mongodb/{+version+}/mongodb" bson-version = "2.11.0" bson-api = "https://docs.rs/bson/{+bson-version+}/bson" diff --git a/source/whats-new.txt b/source/whats-new.txt index 914c30b7..09637578 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -20,12 +20,37 @@ What's New Learn about new features, improvements, and fixes introduced in the following versions of the {+driver-long+}: +* :ref:`Version 3.1 ` * :ref:`Version 3.0.1 ` * :ref:`Version 3.0 ` * :ref:`Version 2.8 ` * :ref:`Version 2.7 ` * :ref:`Version 2.6 ` +.. _rust-version-3.1: + +What's New in 3.1 +----------------- + +The {+driver-short+} v3.1 release includes the following features, +improvements, and fixes: + +- Adds support for more than one KMS (Key Management Service) provider of the same type. + application. To learn more about KMS providers, see + :manual:`Queryable Encryption ` in the {+server+} + manual. +- Adds support for v2 of the Queryable Encryption range protocol. Range indexes for + Queryable Encryption are now GA. +- Adds support for the ``type`` field when creating indexes. To learn more about + creating indexes, see :manual: in the {+server+} manual. +- Implements the :wikipedia:`Happy Eyeballs ` algorithm for managing + TCP connections. +- The driver now publishes a ``TopologyDescriptionChangedEvent`` event when a topology + closes. + +To learn more about this release, see the `v3.1 Release Notes <{+driver-source+}/releases/tag/v3.1.0>`__ +on GitHub. + .. _rust-version-3.0.1: What's New in 3.0.1 From 2272cdd3b6670c659fcf25c74258e9a4cf5a517b Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 3 Sep 2024 10:28:26 -0500 Subject: [PATCH 2/3] link fix --- source/whats-new.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 09637578..28cfba02 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -36,15 +36,16 @@ The {+driver-short+} v3.1 release includes the following features, improvements, and fixes: - Adds support for more than one KMS (Key Management Service) provider of the same type. - application. To learn more about KMS providers, see + To learn more about KMS providers, see :manual:`Queryable Encryption ` in the {+server+} manual. - Adds support for v2 of the Queryable Encryption range protocol. Range indexes for Queryable Encryption are now GA. - Adds support for the ``type`` field when creating indexes. To learn more about - creating indexes, see :manual: in the {+server+} manual. -- Implements the :wikipedia:`Happy Eyeballs ` algorithm for managing - TCP connections. + creating indexes, see :manual:`Indexes ` in the {+server+} manual. +- Implements the Happy Eyeballs algorithm for managing + TCP connections. To learn more about this algorithm, see the Rust documentation + for the `happy_eyeballs `__ crate. - The driver now publishes a ``TopologyDescriptionChangedEvent`` event when a topology closes. From 1dbd0a0be78cb11969a1013e616eee787d678b2b Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 3 Sep 2024 11:28:53 -0500 Subject: [PATCH 3/3] feedback --- source/whats-new.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 28cfba02..7d93da7f 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -35,7 +35,7 @@ What's New in 3.1 The {+driver-short+} v3.1 release includes the following features, improvements, and fixes: -- Adds support for more than one KMS (Key Management Service) provider of the same type. +- Adds support for more than one Key Management Service (KMS) provider of the same type. To learn more about KMS providers, see :manual:`Queryable Encryption ` in the {+server+} manual. @@ -46,7 +46,7 @@ improvements, and fixes: - Implements the Happy Eyeballs algorithm for managing TCP connections. To learn more about this algorithm, see the Rust documentation for the `happy_eyeballs `__ crate. -- The driver now publishes a ``TopologyDescriptionChangedEvent`` event when a topology +- The driver publishes a ``TopologyDescriptionChangedEvent`` event when a topology closes. To learn more about this release, see the `v3.1 Release Notes <{+driver-source+}/releases/tag/v3.1.0>`__