From 050588672b58040e01d9484c8dbc8e7e9b2e0e58 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 13:44:38 -0400 Subject: [PATCH 01/22] DOCSP-49013: Added tips to redirect to installation to use BOM for better version management where kotlin extensions used in java/kotlin docs. --- source/fundamentals/builders/builders-data-classes.txt | 2 ++ source/fundamentals/data-formats/serialization.txt | 2 ++ source/includes/kotlin-driver-coroutine-BOM-tip.rst | 7 +++++++ source/quick-start.txt | 2 ++ 4 files changed, 13 insertions(+) create mode 100644 source/includes/kotlin-driver-coroutine-BOM-tip.rst diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index d562a64e..1bd58fb6 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -49,6 +49,8 @@ To implement this functionality, you must add the ``mongodb-driver-kotlin-extensions`` dependency to your dependencies list. +.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst + 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: diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index d6fe5f10..fd14e6c1 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -340,6 +340,8 @@ a high level of control over how your date and time values are serialized. To use the library, add the ``kotlinx-datetime`` dependency to your project's dependency list. +.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst + Select from the following tabs to see how to add the ``kotlinx-datetime`` dependency to your project by using the :guilabel:`Gradle` and :guilabel:`Maven` package managers: diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst new file mode 100644 index 00000000..64e0770e --- /dev/null +++ b/source/includes/kotlin-driver-coroutine-BOM-tip.rst @@ -0,0 +1,7 @@ +.. tip:: Bill of Materials + + We recommend adding the JVM driver Bill of Materials (BOM) to your + application to manage the versions of driver artifacts. This removes + the need to specify a version for any individual package covered by + the BOM, simplifying dependency management. To learn more, see + more on the BOM :ref:`here. ` \ No newline at end of file diff --git a/source/quick-start.txt b/source/quick-start.txt index 85dc96a0..abd97f0a 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -98,6 +98,8 @@ Because you installed the BOM, you can omit a version in the {+driver-short+} dependency entry. The version you specify in the BOM determines the dependency versions to install. +.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst + After you configure your dependencies, ensure that they are available to your project by running the dependency manager and refreshing the project in your IDE. From 78a925893b1664106041b448bd26de1a1640dff1 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 13:54:49 -0400 Subject: [PATCH 02/22] DOCSP-49013: Added tips to redirect to installation to use BOM for better version management where kotlin extensions used in java/kotlin docs. --- source/includes/kotlin-driver-coroutine-BOM-tip.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst index 64e0770e..d015b24a 100644 --- a/source/includes/kotlin-driver-coroutine-BOM-tip.rst +++ b/source/includes/kotlin-driver-coroutine-BOM-tip.rst @@ -3,5 +3,4 @@ We recommend adding the JVM driver Bill of Materials (BOM) to your application to manage the versions of driver artifacts. This removes the need to specify a version for any individual package covered by - the BOM, simplifying dependency management. To learn more, see - more on the BOM :ref:`here. ` \ No newline at end of file + the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide. ` \ No newline at end of file From 1c0c2c30855ed44e5bb57fe964e42d9777cb1c88 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 14:28:48 -0400 Subject: [PATCH 03/22] DOCSP-49013: Fixing link. --- source/includes/kotlin-driver-coroutine-BOM-tip.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst index d015b24a..121dea1d 100644 --- a/source/includes/kotlin-driver-coroutine-BOM-tip.rst +++ b/source/includes/kotlin-driver-coroutine-BOM-tip.rst @@ -3,4 +3,4 @@ We recommend adding the JVM driver Bill of Materials (BOM) to your application to manage the versions of driver artifacts. This removes the need to specify a version for any individual package covered by - the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide. ` \ No newline at end of file + the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide. ` \ No newline at end of file From 2ea2d5dee710a0fe6dbe15e3751938c7d3d55f6e Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 14:38:48 -0400 Subject: [PATCH 04/22] DOCSP-49013: Includes attempt, link still broken --- source/fundamentals/data-formats/serialization.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index fd14e6c1..31621931 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -60,6 +60,8 @@ Add {+language+} Serialization to Your Project Support for serialization in the {+driver-short+} depends on the official `Kotlin serialization library `__. +.. include:: source/includes/kotlin-driver-coroutine-BOM-tip.rst + 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: From 5a7872668d7e3c526ce5ae1f04f29847120229b1 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 14:58:33 -0400 Subject: [PATCH 05/22] DOCSP-49013-Relocating BOM Tip on Serialization page --- source/fundamentals/data-formats/serialization.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 31621931..5e58e7f9 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -342,8 +342,6 @@ a high level of control over how your date and time values are serialized. To use the library, add the ``kotlinx-datetime`` dependency to your project's dependency list. -.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst - Select from the following tabs to see how to add the ``kotlinx-datetime`` dependency to your project by using the :guilabel:`Gradle` and :guilabel:`Maven` package managers: From 8f69c58af469a8b37d8d3077bdc1ea61b3d812b3 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 15:08:23 -0400 Subject: [PATCH 06/22] DOCSP-49013-fixing link --- source/includes/kotlin-driver-coroutine-BOM-tip.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst index 121dea1d..ca2fc033 100644 --- a/source/includes/kotlin-driver-coroutine-BOM-tip.rst +++ b/source/includes/kotlin-driver-coroutine-BOM-tip.rst @@ -3,4 +3,4 @@ We recommend adding the JVM driver Bill of Materials (BOM) to your application to manage the versions of driver artifacts. This removes the need to specify a version for any individual package covered by - the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide. ` \ No newline at end of file + the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide ` \ No newline at end of file From 5e9f84ccc47a0fea7107a47f31b8dd969fa3cae7 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 15:14:09 -0400 Subject: [PATCH 07/22] DOCSP-49013-fixing serialization --- source/fundamentals/data-formats/serialization.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 5e58e7f9..400cbe5f 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -60,7 +60,7 @@ Add {+language+} Serialization to Your Project Support for serialization in the {+driver-short+} depends on the official `Kotlin serialization library `__. -.. include:: source/includes/kotlin-driver-coroutine-BOM-tip.rst +.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst Select from the following tabs to see how to add the serialization dependencies to your project by using the :guilabel:`Gradle` and From 1d6a8af760cf36dae2bc440da7fd670909a0fda9 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 15:35:17 -0400 Subject: [PATCH 08/22] DOCSP-49013-actual installation page for link --- source/includes/kotlin-driver-coroutine-BOM-tip.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst index ca2fc033..e0940cfe 100644 --- a/source/includes/kotlin-driver-coroutine-BOM-tip.rst +++ b/source/includes/kotlin-driver-coroutine-BOM-tip.rst @@ -3,4 +3,4 @@ We recommend adding the JVM driver Bill of Materials (BOM) to your application to manage the versions of driver artifacts. This removes the need to specify a version for any individual package covered by - the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide ` \ No newline at end of file + the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide ` \ No newline at end of file From 9b55bb22fdfeee9bb07281bc05af455d873d7771 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 15:37:34 -0400 Subject: [PATCH 09/22] DOCSP-49013-reverted link --- source/includes/kotlin-driver-coroutine-BOM-tip.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst index e0940cfe..ca2fc033 100644 --- a/source/includes/kotlin-driver-coroutine-BOM-tip.rst +++ b/source/includes/kotlin-driver-coroutine-BOM-tip.rst @@ -3,4 +3,4 @@ We recommend adding the JVM driver Bill of Materials (BOM) to your application to manage the versions of driver artifacts. This removes the need to specify a version for any individual package covered by - the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide ` \ No newline at end of file + the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide ` \ No newline at end of file From 16913e74fe19274979d7eb6b8feaa13554dbc9ab Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 16:14:08 -0400 Subject: [PATCH 10/22] DOCSP-49013-shared update --- source/fundamentals/builders/builders-data-classes.txt | 6 +++++- source/fundamentals/data-formats/serialization.txt | 6 +++++- source/includes/kotlin-driver-coroutine-BOM-tip.rst | 6 ------ source/quick-start.txt | 6 +++++- 4 files changed, 15 insertions(+), 9 deletions(-) delete mode 100644 source/includes/kotlin-driver-coroutine-BOM-tip.rst diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index 1bd58fb6..a2205944 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -49,7 +49,11 @@ To implement this functionality, you must add the ``mongodb-driver-kotlin-extensions`` dependency to your dependencies list. -.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst +.. sharedinclude:: dbx/jvm/kotlin-driver-coroutine-BOM-tip.rst + + .. replacement:: installation-guide + + :ref:`Installation Guide` Select from the following tabs to see how to add the extension dependency to your project by using the :guilabel:`Gradle` and diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 400cbe5f..0acb5f5f 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -60,7 +60,11 @@ Add {+language+} Serialization to Your Project Support for serialization in the {+driver-short+} depends on the official `Kotlin serialization library `__. -.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst +.. sharedinclude:: dbx/jvm/kotlin-driver-coroutine-BOM-tip.rst + + .. replacement:: installation-guide + + :ref:`Installation Guide` Select from the following tabs to see how to add the serialization dependencies to your project by using the :guilabel:`Gradle` and diff --git a/source/includes/kotlin-driver-coroutine-BOM-tip.rst b/source/includes/kotlin-driver-coroutine-BOM-tip.rst deleted file mode 100644 index ca2fc033..00000000 --- a/source/includes/kotlin-driver-coroutine-BOM-tip.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. tip:: Bill of Materials - - We recommend adding the JVM driver Bill of Materials (BOM) to your - application to manage the versions of driver artifacts. This removes - the need to specify a version for any individual package covered by - the BOM, simplifying dependency management. To learn more, see :ref:`the Installation Guide ` \ No newline at end of file diff --git a/source/quick-start.txt b/source/quick-start.txt index abd97f0a..22390402 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -98,7 +98,11 @@ Because you installed the BOM, you can omit a version in the {+driver-short+} dependency entry. The version you specify in the BOM determines the dependency versions to install. -.. include:: /includes/kotlin-driver-coroutine-BOM-tip.rst +.. sharedinclude:: dbx/jvm/kotlin-driver-coroutine-BOM-tip.rst + + .. replacement:: installation-guide + + :ref:`Installation Guide` After you configure your dependencies, ensure that they are available to your project by running the dependency manager and refreshing the From 62d9a61e9801339c9564bae6f3743faa5f17f21a Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Wed, 4 Jun 2025 16:29:23 -0400 Subject: [PATCH 11/22] DOCSP-49013-update shared file name --- source/fundamentals/builders/builders-data-classes.txt | 2 +- source/fundamentals/data-formats/serialization.txt | 2 +- source/quick-start.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index a2205944..be10ce28 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -49,7 +49,7 @@ To implement this functionality, you must add the ``mongodb-driver-kotlin-extensions`` dependency to your dependencies list. -.. sharedinclude:: dbx/jvm/kotlin-driver-coroutine-BOM-tip.rst +.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst .. replacement:: installation-guide diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 0acb5f5f..e507ef70 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -60,7 +60,7 @@ Add {+language+} Serialization to Your Project Support for serialization in the {+driver-short+} depends on the official `Kotlin serialization library `__. -.. sharedinclude:: dbx/jvm/kotlin-driver-coroutine-BOM-tip.rst +.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst .. replacement:: installation-guide diff --git a/source/quick-start.txt b/source/quick-start.txt index 22390402..ea8ad619 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -98,7 +98,7 @@ Because you installed the BOM, you can omit a version in the {+driver-short+} dependency entry. The version you specify in the BOM determines the dependency versions to install. -.. sharedinclude:: dbx/jvm/kotlin-driver-coroutine-BOM-tip.rst +.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst .. replacement:: installation-guide From 8b8d254efebb7e81269697cd094e2d83830e6182 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 09:38:11 -0400 Subject: [PATCH 12/22] DOCSP-49013-edits, removed versions from implementations and maven instr, better clarity in link wording --- .../fundamentals/builders/builders-data-classes.txt | 6 +++--- .../data-formats/document-data-format-bson.txt | 7 +++++++ source/fundamentals/data-formats/serialization.txt | 13 +++++-------- source/quick-start.txt | 6 ------ 4 files changed, 15 insertions(+), 17 deletions(-) diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index be10ce28..546e5ed8 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -53,7 +53,8 @@ list. .. replacement:: installation-guide - :ref:`Installation Guide` + the :ref:`Add the Driver Bill of Materials ` 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 @@ -70,7 +71,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 @@ -84,7 +85,6 @@ dependency to your project by using the :guilabel:`Gradle` and org.mongodb mongodb-driver-kotlin-extensions - {+full-version+} 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 index ccaf0a6a..eecb79fa 100644 --- a/source/fundamentals/data-formats/document-data-format-bson.txt +++ b/source/fundamentals/data-formats/document-data-format-bson.txt @@ -60,6 +60,13 @@ MongoDB Kotlin driver as a dependency to your project, see the :ref:`driver installation ` section of our Quick Start guide. +.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst + + .. replacement:: installation-guide + + the :ref:`Add the Driver Bill of Materials ` step of the + Quick Start guide. + We recommend that you use the `Maven `__ or `Gradle `__ 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 index e507ef70..ecd6ad36 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -64,7 +64,8 @@ serialization library `__. .. replacement:: installation-guide - :ref:`Installation Guide` + the :ref:`Add the Driver Bill of Materials ` 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 @@ -81,8 +82,8 @@ dependencies to your project by using the :guilabel:`Gradle` and .. code-block:: kotlin :caption: build.gradle.kts - implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion+}") - implementation("org.mongodb:bson-kotlinx:{+full-version+}") + implementation("org.jetbrains.kotlinx:kotlinx-serialization-core") + implementation("org.mongodb:bson-kotlinx") .. tab:: :tabid: Maven @@ -96,12 +97,10 @@ dependencies to your project by using the :guilabel:`Gradle` and org.jetbrains.kotlinx kotlinx-serialization-core - {+serializationVersion+} org.mongodb bson-kotlinx - {+full-version+} .. _kotlin-data-class-annotation: @@ -198,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 @@ -212,7 +211,6 @@ add the dependency to your project by using the :guilabel:`Gradle` and org.jetbrains.kotlinx bson-kotlinx - {+full-version+} .. note:: bson-kotlin Dependency @@ -369,7 +367,6 @@ dependency to your project by using the :guilabel:`Gradle` and org.jetbrains.kotlinx kotlinx-datetime-jvm - {+kotlinx-dt-version+} To learn more about this library, see the :github:`kotlinx-datetime repository diff --git a/source/quick-start.txt b/source/quick-start.txt index ea8ad619..85dc96a0 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -98,12 +98,6 @@ Because you installed the BOM, you can omit a version in the {+driver-short+} dependency entry. The version you specify in the BOM determines the dependency versions to install. -.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst - - .. replacement:: installation-guide - - :ref:`Installation Guide` - After you configure your dependencies, ensure that they are available to your project by running the dependency manager and refreshing the project in your IDE. From db217f551951515414bbfd01851df6ed4b361b1a Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 09:43:32 -0400 Subject: [PATCH 13/22] DOCSP-49013-whitespace, fix link --- source/fundamentals/data-formats/document-data-format-bson.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/fundamentals/data-formats/document-data-format-bson.txt b/source/fundamentals/data-formats/document-data-format-bson.txt index eecb79fa..3aebccf6 100644 --- a/source/fundamentals/data-formats/document-data-format-bson.txt +++ b/source/fundamentals/data-formats/document-data-format-bson.txt @@ -64,7 +64,7 @@ guide. .. replacement:: installation-guide - the :ref:`Add the Driver Bill of Materials ` step of the + the :ref:`Add the Driver Bill of Materials` step of the Quick Start guide. We recommend that you use the `Maven `__ or From ab77d920cce32eccbcf775feb111c6bab762b199 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 09:55:52 -0400 Subject: [PATCH 14/22] DOCSP-49013-fix removal of versions on dependencies --- source/fundamentals/builders/builders-data-classes.txt | 2 +- source/fundamentals/data-formats/serialization.txt | 5 +++-- .../fundamentals/code-snippets/bson-maven-versioned.rst | 1 - 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index 546e5ed8..d81bd713 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -53,7 +53,7 @@ list. .. replacement:: installation-guide - the :ref:`Add the Driver Bill of Materials ` step of the + the :ref:`Add the Driver Bill of Materials` step of the Quick Start guide. Select from the following tabs to see how to add the extension diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index ecd6ad36..51aef45a 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -64,7 +64,7 @@ serialization library `__. .. replacement:: installation-guide - the :ref:`Add the Driver Bill of Materials ` step of the + the :ref:`Add the Driver Bill of Materials` step of the Quick Start guide. Select from the following tabs to see how to add the serialization @@ -82,7 +82,7 @@ dependencies to your project by using the :guilabel:`Gradle` and .. code-block:: kotlin :caption: build.gradle.kts - implementation("org.jetbrains.kotlinx:kotlinx-serialization-core") + implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion}") implementation("org.mongodb:bson-kotlinx") .. tab:: @@ -97,6 +97,7 @@ dependencies to your project by using the :guilabel:`Gradle` and org.jetbrains.kotlinx kotlinx-serialization-core + {+serializationVersion} org.mongodb diff --git a/source/includes/fundamentals/code-snippets/bson-maven-versioned.rst b/source/includes/fundamentals/code-snippets/bson-maven-versioned.rst index 31e1dd6a..665cc6f1 100644 --- a/source/includes/fundamentals/code-snippets/bson-maven-versioned.rst +++ b/source/includes/fundamentals/code-snippets/bson-maven-versioned.rst @@ -4,7 +4,6 @@ org.mongodb bson - {+full-version+} From b5df3e6b6c1bb62ae0af2e792406a128306a6acd Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 09:59:09 -0400 Subject: [PATCH 15/22] DOCSP-49013-shared include link fix? --- source/fundamentals/builders/builders-data-classes.txt | 3 +-- source/fundamentals/data-formats/document-data-format-bson.txt | 3 +-- source/fundamentals/data-formats/serialization.txt | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index d81bd713..4584c148 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -53,8 +53,7 @@ list. .. replacement:: installation-guide - the :ref:`Add the Driver Bill of Materials` step of the - Quick Start guide. + :ref:`Add the Driver Bill of Materials ` 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 diff --git a/source/fundamentals/data-formats/document-data-format-bson.txt b/source/fundamentals/data-formats/document-data-format-bson.txt index 3aebccf6..0612cd0b 100644 --- a/source/fundamentals/data-formats/document-data-format-bson.txt +++ b/source/fundamentals/data-formats/document-data-format-bson.txt @@ -64,8 +64,7 @@ guide. .. replacement:: installation-guide - the :ref:`Add the Driver Bill of Materials` step of the - Quick Start guide. + :ref:`Add the Driver Bill of Materials ` step of the Quick Start guide. We recommend that you use the `Maven `__ or `Gradle `__ build automation tool to manage your project's diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 51aef45a..ec3040cf 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -64,8 +64,7 @@ serialization library `__. .. replacement:: installation-guide - the :ref:`Add the Driver Bill of Materials` step of the - Quick Start guide. + :ref:`Add the Driver Bill of Materials ` 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 From 5a32034a238cc5b9f4a7a322f2cb0d0c09af2d7a Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 10:13:42 -0400 Subject: [PATCH 16/22] DOCSP-49013-fix grammar on link --- source/fundamentals/data-formats/serialization.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index ec3040cf..9f824025 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -64,7 +64,7 @@ serialization library `__. .. replacement:: installation-guide - :ref:`Add the Driver Bill of Materials ` step of the Quick Start guide. + :ref:`the Add the Driver Bill of Materials ` 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 From 4195a9b58c9b43cf8d1caa805aeddede6fc3c591 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 10:18:03 -0400 Subject: [PATCH 17/22] DOCSP-49013-fix grammar on link --- source/fundamentals/data-formats/serialization.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 9f824025..ec3040cf 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -64,7 +64,7 @@ serialization library `__. .. replacement:: installation-guide - :ref:`the Add the Driver Bill of Materials ` step of the Quick Start guide. + :ref:`Add the Driver Bill of Materials ` 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 From 7ff15855bc7ca8479aa75134123e95f51838ac1c Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 10:31:33 -0400 Subject: [PATCH 18/22] DOCSP-49013-removed versions from mongodb-crypt and all kotlin(x) implementations managed by BOM --- source/fundamentals/data-formats/serialization.txt | 1 + source/fundamentals/encrypt-fields.txt | 6 ++++++ .../fundamentals/code-snippets/bson-gradle-versioned.rst | 2 +- .../fundamentals/code-snippets/crypt-gradle-versioned.rst | 2 +- .../fundamentals/code-snippets/crypt-maven-versioned.rst | 1 - source/includes/serialization-libs-gradle-versioned.rst | 4 ++-- source/includes/serialization-libs-maven-versioned.rst | 2 -- 7 files changed, 11 insertions(+), 7 deletions(-) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index ec3040cf..4ea51458 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -367,6 +367,7 @@ dependency to your project by using the :guilabel:`Gradle` and org.jetbrains.kotlinx kotlinx-datetime-jvm + {+kotlinx-dt-version+} To learn more about this library, see the :github:`kotlinx-datetime repository diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 0fa23918..78b94470 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -26,3 +26,9 @@ :tabid: gradle-dependency .. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst + +.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst + + .. replacement:: installation-guide + + :ref:`Add the Driver Bill of Materials ` step of the Quick Start guide. diff --git a/source/includes/fundamentals/code-snippets/bson-gradle-versioned.rst b/source/includes/fundamentals/code-snippets/bson-gradle-versioned.rst index c830af9b..d71aed34 100644 --- 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/crypt-gradle-versioned.rst b/source/includes/fundamentals/code-snippets/crypt-gradle-versioned.rst index af6427b6..f5284de2 100644 --- 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") } \ No newline at end of file diff --git a/source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst b/source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst index 0b2c3b0e..db9fa409 100644 --- a/source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst +++ b/source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst @@ -4,6 +4,5 @@ org.mongodb mongodb-crypt - {+mongocrypt-version+} diff --git a/source/includes/serialization-libs-gradle-versioned.rst b/source/includes/serialization-libs-gradle-versioned.rst index ac994c76..971caa33 100644 --- 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") \ No newline at end of file diff --git a/source/includes/serialization-libs-maven-versioned.rst b/source/includes/serialization-libs-maven-versioned.rst index 16ba6eb6..9fb8d6ee 100644 --- a/source/includes/serialization-libs-maven-versioned.rst +++ b/source/includes/serialization-libs-maven-versioned.rst @@ -5,12 +5,10 @@ org.mongodb bson-kotlinx - {+full-version+} org.mongodb bson-kotlin - {+full-version+} \ No newline at end of file From 87c888b4503aac63e888857e6970d1316a2edd57 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 10:38:02 -0400 Subject: [PATCH 19/22] DOCSP-49013-encrypt fields update position of tio --- source/fundamentals/encrypt-fields.txt | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 78b94470..0b6f886b 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -4,6 +4,13 @@ .. replacement:: driver-specific-content + .. sharedinclude:: dbx/jvm/BOM-installation-tip.rst + + .. replacement:: installation-guide + + :ref:`Add the Driver Bill of Materials ` step of the Quick Start guide. + + .. important:: Compatible Encryption Library Version The {+driver-short+} uses the `mongodb-crypt @@ -26,9 +33,3 @@ :tabid: gradle-dependency .. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst - -.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst - - .. replacement:: installation-guide - - :ref:`Add the Driver Bill of Materials ` step of the Quick Start guide. From 283f651fff13598071018eee613399d50b5cf0af Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 11:17:41 -0400 Subject: [PATCH 20/22] DOCSP-49013-suggested changes --- .../data-formats/serialization.txt | 4 +- source/fundamentals/encrypt-fields.txt | 48 +++++++++---------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/source/fundamentals/data-formats/serialization.txt b/source/fundamentals/data-formats/serialization.txt index 4ea51458..5e29f486 100644 --- a/source/fundamentals/data-formats/serialization.txt +++ b/source/fundamentals/data-formats/serialization.txt @@ -81,7 +81,7 @@ dependencies to your project by using the :guilabel:`Gradle` and .. code-block:: kotlin :caption: build.gradle.kts - implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion}") + implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion+}") implementation("org.mongodb:bson-kotlinx") .. tab:: @@ -96,7 +96,7 @@ dependencies to your project by using the :guilabel:`Gradle` and org.jetbrains.kotlinx kotlinx-serialization-core - {+serializationVersion} + {+serializationVersion+} org.mongodb diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 0b6f886b..5ba31099 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -1,6 +1,14 @@ .. _kotlin-fle: -.. sharedinclude:: dbx/encrypt-fields.rst +Compatible Encryption Library Version +------------------------------------- + + The {+driver-short+} uses the `mongodb-crypt + `__ + encryption library for in-use encryption. This driver version + is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}. + + .. sharedinclude:: dbx/encrypt-fields.rst .. replacement:: driver-specific-content @@ -10,26 +18,18 @@ :ref:`Add the Driver Bill of Materials ` step of the Quick Start guide. - - .. important:: Compatible Encryption Library Version - - The {+driver-short+} uses the `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 + 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 From 40e7ed1a65ebdb674dcf54aae5752f99e2ee20fe Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 11:24:39 -0400 Subject: [PATCH 21/22] DOCSP-49013-encryption reformat --- source/fundamentals/encrypt-fields.txt | 46 +++++++++++++------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 5ba31099..0a5827b7 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -1,16 +1,16 @@ .. _kotlin-fle: -Compatible Encryption Library Version -------------------------------------- +.. sharedinclude:: dbx/encrypt-fields.rst - The {+driver-short+} uses the `mongodb-crypt - `__ - encryption library for in-use encryption. This driver version - is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}. + .. replacement:: driver-specific-content - .. sharedinclude:: dbx/encrypt-fields.rst + Compatible Encryption Library Version + ------------------------------------- - .. replacement:: driver-specific-content + The {+driver-short+} uses the `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 @@ -18,18 +18,18 @@ Compatible Encryption Library Version :ref:`Add the Driver Bill of Materials ` 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 + 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 From e9fc0f509c3b43d5b5d5896a4d5b58371d9eaea3 Mon Sep 17 00:00:00 2001 From: Melanie Ballard Date: Thu, 5 Jun 2025 12:00:51 -0400 Subject: [PATCH 22/22] DOCSP-49013-indentation --- source/fundamentals/encrypt-fields.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 0a5827b7..884fed0c 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -7,10 +7,10 @@ Compatible Encryption Library Version ------------------------------------- - The {+driver-short+} uses the `mongodb-crypt - `__ - encryption library for in-use encryption. This driver version - is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}. + The {+driver-short+} uses the `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