Skip to content

Commit f66834b

Browse files
authored
DOCSP-49013 BOM Tip for Kotlin Sync (#99)
* DOCSP-49013 BOM Tip for Kotlin Sync
1 parent 5fb716f commit f66834b

12 files changed

+53
-38
lines changed

source/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-sync-get-started-install-bom>` step of the Get Started 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/data-formats/bson.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ For instructions on how to add the {+driver-long+} as a dependency to your proje
6060
:ref:`driver installation <kotlin-sync-download-install>` section of our Get Started
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-sync-get-started-install-bom>` step of the Get Started 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 {+language+}
6571
project's dependencies. The following instructions detail the dependency declarations for

source/data-formats/serialization.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,13 @@ application. To learn more about this library, see the
6565
`kotlinx.serialization GitHub repository
6666
<https://github.com/Kotlin/kotlinx.serialization>`__.
6767

68+
.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst
69+
70+
.. replacement:: installation-guide
71+
72+
:ref:`Add the Driver Bill of Materials <kotlin-sync-get-started-install-bom>` step of the Get Started guide.
73+
74+
6875
Select from the following tabs to see how to add the serialization
6976
dependencies to your project by using either :guilabel:`Gradle` or
7077
:guilabel:`Maven`:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. code-block:: kotlin
22
33
dependencies {
4-
implementation("org.mongodb:bson:{+full-version+}")
4+
implementation("org.mongodb:bson")
55
}

source/includes/data-formats/bson-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>bson</artifactId>
7-
<version>{+full-version+}</version>
87
</dependency>
98
</dependencies>

source/includes/data-formats/serialization-gradle-versioned.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
:caption: build.gradle.kts
33
44
implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serialization-version+}")
5-
implementation("org.mongodb:bson-kotlinx:{+full-version+}")
5+
implementation("org.mongodb:bson-kotlinx")

source/includes/data-formats/serialization-maven-versioned.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@
99
<dependency>
1010
<groupId>org.mongodb</groupId>
1111
<artifactId>bson-kotlinx</artifactId>
12-
<version>{+full-version+}</version>
1312
</dependency>
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/security/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/index.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
Run a Command </run-command>
2626
Monitoring </monitoring>
2727
Security </security>
28-
In-Use Encryption </security/encrypt-fields>
2928
Compatibility </compatibility>
3029
Validate Driver Signatures </validate-signatures>
3130
What's New </whats-new>
@@ -95,12 +94,6 @@ Use Builders API
9594

9695
Learn how to work with the builder operation helpers in the :ref:`kotlin-sync-builders` section.
9796

98-
In-Use Encryption
99-
-----------------
100-
101-
Learn how to use in-use encryption to encrypt your MongoDB data in the
102-
:ref:`In-Use Encryption <kotlin-sync-fle>` section.
103-
10497
Compatibility
10598
-------------
10699

source/security/authentication.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ mechanism:
8787
:end-before: end-default-mongo-cred
8888
:dedent:
8989

90-
You can also explicitly specify the `SCRAM-SHA-256`` authentication mechanism,
90+
You can also explicitly specify the ``SCRAM-SHA-256`` authentication mechanism,
9191
as shown in the following code snippets.
9292

9393
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`

source/security/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/security/crypt-maven-versioned.rst
24-
25-
.. tab:: Gradle
26-
:tabid: gradle-dependency
27-
28-
.. include:: /includes/security/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-sync-get-started-install-bom>` step of the Get Started 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/security/crypt-maven-versioned.rst
31+
32+
.. tab:: Gradle
33+
:tabid: gradle-dependency
34+
35+
.. include:: /includes/security/crypt-gradle-versioned.rst

0 commit comments

Comments
 (0)