Skip to content

Commit 4eca211

Browse files
authored
Docsp-49013 (#226) (#229)
* 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)
1 parent 7046a65 commit 4eca211

10 files changed

+54
-36
lines changed

source/fundamentals/builders/builders-data-classes.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ To implement this functionality, you must add the
4949
``mongodb-driver-kotlin-extensions`` dependency to your dependencies
5050
list.
5151

52+
.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
53+
54+
.. replacement:: installation-guide
55+
56+
:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
57+
5258
Select from the following tabs to see how to add the extension
5359
dependency to your project by using the :guilabel:`Gradle` and
5460
:guilabel:`Maven` package managers:
@@ -64,7 +70,7 @@ dependency to your project by using the :guilabel:`Gradle` and
6470
.. code-block:: kotlin
6571
:caption: build.gradle.kts
6672

67-
implementation("org.mongodb:mongodb-driver-kotlin-extensions:{+full-version+}")
73+
implementation("org.mongodb:mongodb-driver-kotlin-extensions")
6874

6975
.. tab::
7076
:tabid: Maven
@@ -78,7 +84,6 @@ dependency to your project by using the :guilabel:`Gradle` and
7884
<dependency>
7985
<groupId>org.mongodb</groupId>
8086
<artifactId>mongodb-driver-kotlin-extensions</artifactId>
81-
<version>{+full-version+}</version>
8287
</dependency>
8388

8489
After you install the extensions dependency, you can use the extension

source/fundamentals/data-formats/document-data-format-bson.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ MongoDB Kotlin driver as a dependency to your project, see the
6060
:ref:`driver installation <add-mongodb-dependency>` section of our Quick Start
6161
guide.
6262

63+
.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
64+
65+
.. replacement:: installation-guide
66+
67+
:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
68+
6369
We recommend that you use the `Maven <https://maven.apache.org/>`__ or
6470
`Gradle <https://gradle.org/>`__ build automation tool to manage your project's
6571
dependencies. Select from the following tabs to see the dependency declaration

source/fundamentals/data-formats/serialization.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ Add {+language+} Serialization to Your Project
6060
Support for serialization in the {+driver-short+} depends on the official `Kotlin
6161
serialization library <https://github.com/Kotlin/kotlinx.serialization>`__.
6262

63+
.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
64+
65+
.. replacement:: installation-guide
66+
67+
:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
68+
6369
Select from the following tabs to see how to add the serialization
6470
dependencies to your project by using the :guilabel:`Gradle` and
6571
:guilabel:`Maven` package managers:
@@ -76,7 +82,7 @@ dependencies to your project by using the :guilabel:`Gradle` and
7682
:caption: build.gradle.kts
7783

7884
implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion+}")
79-
implementation("org.mongodb:bson-kotlinx:{+full-version+}")
85+
implementation("org.mongodb:bson-kotlinx")
8086

8187
.. tab::
8288
:tabid: Maven
@@ -95,7 +101,6 @@ dependencies to your project by using the :guilabel:`Gradle` and
95101
<dependency>
96102
<groupId>org.mongodb</groupId>
97103
<artifactId>bson-kotlinx</artifactId>
98-
<version>{+full-version+}</version>
99104
</dependency>
100105

101106
.. _kotlin-data-class-annotation:
@@ -192,7 +197,7 @@ add the dependency to your project by using the :guilabel:`Gradle` and
192197
.. code-block:: kotlin
193198
:caption: build.gradle.kts
194199

195-
implementation("org.mongodb:bson-kotlinx:{+full-version+}")
200+
implementation("org.mongodb:bson-kotlinx")
196201

197202
.. tab::
198203
:tabid: Maven
@@ -206,7 +211,6 @@ add the dependency to your project by using the :guilabel:`Gradle` and
206211
<dependency>
207212
<groupId>org.jetbrains.kotlinx</groupId>
208213
<artifactId>bson-kotlinx</artifactId>
209-
<version>{+full-version+}</version>
210214
</dependency>
211215

212216
.. note:: bson-kotlin Dependency

source/fundamentals/encrypt-fields.txt

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,32 @@
44

55
.. replacement:: driver-specific-content
66

7-
.. important:: Compatible Encryption Library Version
8-
9-
The {+driver-short+} uses the `mongodb-crypt
10-
<https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
11-
encryption library for in-use encryption. This driver version
12-
is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.
13-
14-
Select from the following :guilabel:`Maven` and
15-
:guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
16-
dependency to your project by using the specified manager:
17-
18-
.. tabs::
19-
20-
.. tab:: Maven
21-
:tabid: maven-dependency
22-
23-
.. include:: /includes/fundamentals/code-snippets/crypt-maven-versioned.rst
24-
25-
.. tab:: Gradle
26-
:tabid: gradle-dependency
27-
28-
.. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
7+
Compatible Encryption Library Version
8+
-------------------------------------
9+
10+
The {+driver-short+} uses the `mongodb-crypt
11+
<https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
12+
encryption library for in-use encryption. This driver version
13+
is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.
14+
15+
.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
16+
17+
.. replacement:: installation-guide
18+
19+
:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.
20+
21+
Select from the following :guilabel:`Maven` and
22+
:guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
23+
dependency to your project by using the specified manager:
24+
25+
.. tabs::
26+
27+
.. tab:: Maven
28+
:tabid: maven-dependency
29+
30+
.. include:: /includes/fundamentals/code-snippets/crypt-maven-versioned.rst
31+
32+
.. tab:: Gradle
33+
:tabid: gradle-dependency
34+
35+
.. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. code-block:: kotlin
22
33
dependencies {
4-
implementation("org.mongodb:bson:{+full-version+}")
4+
implementation("org.mongodb:bson")
55
}
66

source/includes/fundamentals/code-snippets/bson-maven-versioned.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
<dependency>
55
<groupId>org.mongodb</groupId>
66
<artifactId>bson</artifactId>
7-
<version>{+full-version+}</version>
87
</dependency>
98
</dependencies>
109
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. code-block:: groovy
22
33
dependencies {
4-
implementation("org.mongodb:mongodb-crypt:{+mongocrypt-version+}")
4+
implementation("org.mongodb:mongodb-crypt")
55
}

source/includes/fundamentals/code-snippets/crypt-maven-versioned.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@
44
<dependency>
55
<groupId>org.mongodb</groupId>
66
<artifactId>mongodb-crypt</artifactId>
7-
<version>{+mongocrypt-version+}</version>
87
</dependency>
98
</dependencies>

source/includes/serialization-libs-gradle-versioned.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:caption: build.gradle.kts
33
:copyable: true
44
5-
implementation("org.mongodb:bson-kotlinx:{+full-version+}")
5+
implementation("org.mongodb:bson-kotlinx")
66
// OR
7-
implementation("org.mongodb:bson-kotlin:{+full-version+}")
7+
implementation("org.mongodb:bson-kotlin")
88

source/includes/serialization-libs-maven-versioned.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@
55
<dependency>
66
<groupId>org.mongodb</groupId>
77
<artifactId>bson-kotlinx</artifactId>
8-
<version>{+full-version+}</version>
98
</dependency>
109
<!--OR-->
1110
<dependency>
1211
<groupId>org.mongodb</groupId>
1312
<artifactId>bson-kotlin</artifactId>
14-
<version>{+full-version+}</version>
1513
</dependency>
1614

0 commit comments

Comments
 (0)