Merge pull request #3 from rustagir/DOCSP-30559-compat

DOCSP-30559: compatibility

Author: rustagir

.gitignore

@@ -5,12 +5,6 @@
 *.so
 *.dylib
 
-# Test binary, built with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
-
 # Dependency directories (remove the comment below to include it)
 # vendor/
 
@@ -19,5 +13,4 @@
 .idea
 
 # System
-
 .DS_Store

snooty.toml

@@ -16,6 +16,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
 [constants]
 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 = "2.6.0" # always set this to the driver version (i.e. 2.6.0, 2.5.0, etc.)
 api = "https://docs.rs/mongodb/{+version+}/mongodb"

source/compatibility.txt

@@ -0,0 +1,31 @@
+.. _rust-compatibility:
+
+=============
+Compatibility
+=============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+MongoDB Compatibility
+---------------------
+
+The following compatibility table specifies the versions of the
+{+driver-long+} you can use with each version of MongoDB.
+
+The first column lists the driver version.
+
+.. sharedinclude:: dbx/compatibility-table-legend.rst
+
+.. include:: /includes/mongodb-compatibility-table-rust.rst
+
+Language Compatibility
+----------------------
+
+.. include:: /includes/language-compatibility-table-rust.rst
+
+For more information on how to read the compatibility tables, see our guide on 
+:ref:`MongoDB Compatibility Tables <about-driver-compatibility>`.

source/includes/language-compatibility-table-rust.rst

@@ -0,0 +1 @@
+The {+driver-long+} requires Rust 1.57 or later.

source/includes/mongodb-compatibility-table-rust.rst

@@ -0,0 +1,97 @@
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :class: compatibility-large
+
+   * - Rust Driver Version
+     - MongoDB 7.0
+     - MongoDB 6.0
+     - MongoDB 5.0
+     - MongoDB 4.4
+     - MongoDB 4.2
+     - MongoDB 4.0
+     - MongoDB 3.6
+   * - 2.6 [#2.5-2.6-limitation]_
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+   * - 2.5 [#2.5-2.6-limitation]_
+     - ⊛
+     - ⊛
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+   * - 2.4 [#2.4-limitation]_
+     - ⊛
+     - ⊛
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+   * - 2.3 [#2.2-2.3-limitation]_
+     - ⊛
+     - ⊛
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+   * - 2.2 [#2.2-2.3-limitation]_
+     - ⊛
+     - ⊛
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+   * - 2.1 [#2.1-limitation]_
+     - ⊛
+     - ⊛
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+   * - 2.0 [#2.0-limitation]_
+     - ⊛
+     - ⊛
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+
+The {+driver-short+} is not compatible with {+server+} versions
+older than 3.6.
+
+.. [#2.5-2.6-limitation] This {+driver-short+} version does not support
+   :manual:`OCSP </core/security-transport-encryption/#ocsp--online-certificate-status-protocol->`.
+
+.. [#2.4-limitation] This {+driver-short+} version does not support Decimal128
+   or :manual:`OCSP </core/security-transport-encryption/#ocsp--online-certificate-status-protocol->`.
+
+.. [#2.2-2.3-limitation] This {+driver-short+} version does not support Decimal128,
+   :ref:`Client-Side Field Level Encryption <manual-csfle-feature>`,
+   :manual:`GridFS </core/gridfs/>`, or
+   :manual:`OCSP </core/security-transport-encryption/#ocsp--online-certificate-status-protocol->`.
+
+.. [#2.1-limitation] This {+driver-short+} version does not support Decimal128,
+   :ref:`Client-Side Field Level Encryption <manual-csfle-feature>`,
+   :manual:`GridFS </core/gridfs/>`,
+   :manual:`OCSP </core/security-transport-encryption/#ocsp--online-certificate-status-protocol->`,
+   or :ref:`change streams <changeStreams>`.
+
+.. [#2.0-limitation] This {+driver-short+} version does not support Decimal128,
+   :ref:`Client-Side Field Level Encryption <manual-csfle-feature>`,
+   :manual:`GridFS </core/gridfs/>`,
+   :manual:`OCSP </core/security-transport-encryption/#ocsp--online-certificate-status-protocol->`,
+   :ref:`change streams <changeStreams>`,
+   :manual:`Causal Consistency </core/causal-consistency-read-write-concerns>`, or
+   :atlas:`Serverless Instances </create-database-deployment/#serverless-instances>`.

source/index.txt

@@ -8,6 +8,7 @@
 
    /fundamentals
    API Documentation <{+api+}/>
+   /compatibility
    View the Source <https://github.com/mongodb/mongo-rust-driver>
 
 ..
@@ -18,7 +19,6 @@
    /faq
    /connection-troubleshooting
    /issues-and-help
-   /compatibility
 
 Introduction
 ------------
@@ -78,8 +78,9 @@ Issues & Help
 Compatibility
 -------------
 
-.. For the compatibility charts that show the recommended {+driver-short+} version
-.. for each MongoDB Server version, see :ref:`rust-compatibility`.
+To learn about the versions of the {+server+} and the Rust language
+that are compatible with each version of the {+driver-short+}, see
+:ref:`rust-compatibility`.
 
 Learn
 ------