Docsp-49013 (#226)

mballard-mdb · mballard-mdb · commit 63ed78259e05 · 2025-06-06T10:58:25.000-04:00
* DOCSP-49013: Added tips to redirect to installation to use BOM for better version management where kotlin extensions used in java/kotlin docs. * DOCSP-49013: Added tips to redirect to installation to use BOM for better version management where kotlin extensions used in java/kotlin docs. * DOCSP-49013: Fixing link. * DOCSP-49013: Includes attempt, link still broken * DOCSP-49013-Relocating BOM Tip on Serialization page * DOCSP-49013-fixing link * DOCSP-49013-fixing serialization * DOCSP-49013-actual installation page for link * DOCSP-49013-reverted link * DOCSP-49013-shared update * DOCSP-49013-update shared file name * DOCSP-49013-edits, removed versions from implementations and maven instr, better clarity in link wording * DOCSP-49013-whitespace, fix link * DOCSP-49013-fix removal of versions on dependencies * DOCSP-49013-shared include link fix? * DOCSP-49013-fix grammar on link * DOCSP-49013-fix grammar on link * DOCSP-49013-removed versions from mongodb-crypt and all kotlin(x) implementations managed by BOM * DOCSP-49013-encrypt fields update position of tio * DOCSP-49013-suggested changes * DOCSP-49013-encryption reformat * DOCSP-49013-indentation (cherry picked from commit 10143aa)
diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt
@@ -49,6 +49,12 @@ To implement this functionality, you must add the
 ``mongodb-driver-kotlin-extensions`` dependency to your dependencies
 list.
 
+.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
+
+   .. replacement:: installation-guide
+
+      :ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
+
 Select from the following tabs to see how to add the extension
 dependency to your project by using the :guilabel:`Gradle` and
 :guilabel:`Maven` package managers:
@@ -64,7 +70,7 @@ dependency to your project by using the :guilabel:`Gradle` and
       .. code-block:: kotlin
          :caption: build.gradle.kts
  
-         implementation("org.mongodb:mongodb-driver-kotlin-extensions:{+full-version+}")
+         implementation("org.mongodb:mongodb-driver-kotlin-extensions")
 
    .. tab::
       :tabid: Maven
@@ -78,7 +84,6 @@ dependency to your project by using the :guilabel:`Gradle` and
          <dependency>
              <groupId>org.mongodb</groupId>
              <artifactId>mongodb-driver-kotlin-extensions</artifactId>
-             <version>{+full-version+}</version>
          </dependency>
 
 After you install the extensions dependency, you can use the extension
diff --git a/source/fundamentals/data-formats/document-data-format-bson.txt b/source/fundamentals/data-formats/document-data-format-bson.txt
@@ -60,6 +60,12 @@ MongoDB Kotlin driver as a dependency to your project, see the
 :ref:`driver installation <add-mongodb-dependency>` section of our Quick Start
 guide.
 
+.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
+
+   .. replacement:: installation-guide
+
+      :ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
+
 We recommend that you use the `Maven <https://maven.apache.org/>`__ or
 `Gradle <https://gradle.org/>`__ build automation tool to manage your project's
 dependencies. Select from the following tabs to see the dependency declaration
diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt
@@ -60,6 +60,12 @@ Add {+language+} Serialization to Your Project
 Support for serialization in the {+driver-short+} depends on the official `Kotlin
 serialization library <https://github.com/Kotlin/kotlinx.serialization>`__.
 
+.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
+
+   .. replacement:: installation-guide
+
+      :ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
+
 Select from the following tabs to see how to add the serialization
 dependencies to your project by using the :guilabel:`Gradle` and
 :guilabel:`Maven` package managers:
@@ -76,7 +82,7 @@ dependencies to your project by using the :guilabel:`Gradle` and
         :caption: build.gradle.kts
 
         implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion+}")
-        implementation("org.mongodb:bson-kotlinx:{+full-version+}")
+        implementation("org.mongodb:bson-kotlinx")
 
    .. tab::
       :tabid: Maven
@@ -95,7 +101,6 @@ dependencies to your project by using the :guilabel:`Gradle` and
         <dependency>
             <groupId>org.mongodb</groupId>
             <artifactId>bson-kotlinx</artifactId>
-            <version>{+full-version+}</version>
         </dependency>
 
 .. _kotlin-data-class-annotation:
@@ -192,7 +197,7 @@ add the dependency to your project by using the :guilabel:`Gradle` and
       .. code-block:: kotlin
         :caption: build.gradle.kts
 
-        implementation("org.mongodb:bson-kotlinx:{+full-version+}")
+        implementation("org.mongodb:bson-kotlinx")
 
    .. tab::
       :tabid: Maven
@@ -206,7 +211,6 @@ add the dependency to your project by using the :guilabel:`Gradle` and
         <dependency>
             <groupId>org.jetbrains.kotlinx</groupId>
             <artifactId>bson-kotlinx</artifactId>
-            <version>{+full-version+}</version>
         </dependency>
 
 .. note:: bson-kotlin Dependency
diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt
@@ -4,25 +4,32 @@
 
    .. replacement:: driver-specific-content
 
-      .. important:: Compatible Encryption Library Version
-
-         The {+driver-short+} uses the `mongodb-crypt
-         <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
-         encryption library for in-use encryption. This driver version
-         is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.
-
-         Select from the following :guilabel:`Maven` and
-         :guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
-         dependency to your project by using the specified manager:
-         
-         .. tabs::
-         
-            .. tab:: Maven
-               :tabid: maven-dependency
-         
-               .. include:: /includes/fundamentals/code-snippets/crypt-maven-versioned.rst
-         
-            .. tab:: Gradle
-               :tabid: gradle-dependency
-         
-               .. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
+      Compatible Encryption Library Version
+      -------------------------------------
+
+      The {+driver-short+} uses the `mongodb-crypt
+      <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
+      encryption library for in-use encryption. This driver version
+      is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.
+
+      .. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
+
+         .. replacement:: installation-guide
+
+            :ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
+
+      Select from the following :guilabel:`Maven` and
+      :guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
+      dependency to your project by using the specified manager:
+      
+      .. tabs::
+      
+         .. tab:: Maven
+            :tabid: maven-dependency
+      
+            .. include:: /includes/fundamentals/code-snippets/crypt-maven-versioned.rst
+      
+         .. tab:: Gradle
+            :tabid: gradle-dependency
+      
+            .. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
diff --git a/source/includes/fundamentals/code-snippets/bson-gradle-versioned.rst b/source/includes/fundamentals/code-snippets/bson-gradle-versioned.rst
@@ -1,6 +1,6 @@
 .. code-block:: kotlin
 
    dependencies {
-      implementation("org.mongodb:bson:{+full-version+}")
+      implementation("org.mongodb:bson")
    }
 
diff --git a/source/includes/fundamentals/code-snippets/bson-maven-versioned.rst b/source/includes/fundamentals/code-snippets/bson-maven-versioned.rst
@@ -4,7 +4,6 @@
        <dependency>
            <groupId>org.mongodb</groupId>
            <artifactId>bson</artifactId>
-           <version>{+full-version+}</version>
        </dependency>
    </dependencies>
 
diff --git a/source/includes/fundamentals/code-snippets/crypt-gradle-versioned.rst b/source/includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
@@ -1,5 +1,5 @@
 .. code-block:: groovy
 
    dependencies {
-      implementation("org.mongodb:mongodb-crypt:{+mongocrypt-version+}")
+      implementation("org.mongodb:mongodb-crypt")
    }
diff --git a/source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst b/source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst
@@ -4,6 +4,5 @@
        <dependency>
            <groupId>org.mongodb</groupId>
            <artifactId>mongodb-crypt</artifactId>
-           <version>{+mongocrypt-version+}</version>
        </dependency>
    </dependencies>
diff --git a/source/includes/serialization-libs-gradle-versioned.rst b/source/includes/serialization-libs-gradle-versioned.rst
@@ -2,7 +2,7 @@
    :caption: build.gradle.kts
    :copyable: true
 
-   implementation("org.mongodb:bson-kotlinx:{+full-version+}")
+   implementation("org.mongodb:bson-kotlinx")
    // OR
-   implementation("org.mongodb:bson-kotlin:{+full-version+}")
+   implementation("org.mongodb:bson-kotlin")
    
diff --git a/source/includes/serialization-libs-maven-versioned.rst b/source/includes/serialization-libs-maven-versioned.rst
@@ -5,12 +5,10 @@
    <dependency>
        <groupId>org.mongodb</groupId>
        <artifactId>bson-kotlinx</artifactId>
-       <version>{+full-version+}</version>
    </dependency>
    <!--OR-->
    <dependency>
        <groupId>org.mongodb</groupId>
        <artifactId>bson-kotlin</artifactId>
-       <version>{+full-version+}</version>
    </dependency>
   

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.. code-block:: kotlin`
`2`	`2`
`3`	`3`	`dependencies {`
`4`		`- implementation("org.mongodb:bson:{+full-version+}")`
	`4`	`+ implementation("org.mongodb:bson")`
`5`	`5`	`}`
`6`	`6`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`.. code-block:: groovy`
`2`	`2`
`3`	`3`	`dependencies {`
`4`		`- implementation("org.mongodb:mongodb-crypt:{+mongocrypt-version+}")`
	`4`	`+ implementation("org.mongodb:mongodb-crypt")`
`5`	`5`	`}`