10000 Update api links for 5.5 link changes (#217) · mongodb/docs-kotlin@7dbba8b · GitHub
[go: up one dir, main page]
Skip to content

Commit 7dbba8b

Browse files
rustagirrustagir
authored
Update api links for 5.5 link changes (#217)
1 parent f021aaf commit 7dbba8b

File tree

8 files changed

+26
-25
lines changed

8 files changed

+26
-25
lines changed

‎snooty.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
2020
driver = "kotlin"
2121
driver-short = "Kotlin driver"
2222
driver-long = "MongoDB Kotlin Driver"
23-
version = "5.4"
23+
version = "5.5"
2424
full-version = "{+version+}.0"
2525
language = "Kotlin"
2626
mdb-server = "MongoDB server"
2727
kotlin-docs = "https://kotlinlang.org"
2828

2929
package-name-org = "mongodb-org"
3030
api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
31-
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
32-
driver-api = "{+api-root+}/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine"
31+
core-api = "{+api-root+}/driver-core/com/mongodb"
32+
driver-api = "{+api-root+}/driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine"
3333
stable-api = "Stable API"
3434
mongocrypt-version = "{+full-version+}"
3535
snappyVersion = "org.xerial.snappy:snappy-java:1.1.8.4"

‎source/api-documentation.txt

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,19 @@ API Documentation
99
:titlesonly:
1010
:maxdepth: 1
1111

12+
{+language+} Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>
1213
BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>
13-
{+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>
14-
Driver Core <{+api-root+}/mongodb-driver-core/index.html>
15-
{+language+} Coroutine Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>
16-
{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>
14+
{+language+} Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html>
15+
Driver Core <{+api-root+}/driver-core/index.html>
1716

17+
- `{+language+} Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>`__ -
18+
classes for the current driver API using coroutines.
1819
- `BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>`__ -
1920
classes for encoding and decoding between Kotlin data classes and the BSON data
2021
format using :github:`kotlinx.serialization <Kotlin/kotlinx.serialization>`.
2122
- `{+language+} Driver Extensions
22-
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ -
23+
<{+api-root+}/driver-kotlin-extensions/index.html>`__ -
2324
classes that extend the core builder classes to support :ref:`data
2425
classes <kotlin-builders-data-classes>`.
25-
- `Driver Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
26+
- `Driver Core <{+api-root+}/driver-core/index.html>`__ - classes that
2627
contain essential driver functionality.
27-
- `{+language+} Coroutine Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>`__ -
28-
classes for the current driver API using coroutines.
29-
- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ -
30-
classes for the current synchronous driver API.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,4 +246,4 @@ API Documentation
246246
-----------------
247247

248248
- `{+driver-short+} Extensions
249-
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__
249+
<{+api-root+}/driver-kotlin-extensions/index.html>`__

‎source/fundamentals/connection/socks5.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,6 @@ following API documentation:
110110

111111
- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
112112
- `SocketSettings.Builder <{+core-api+}/connection/SocketSettings.Builder.html>`__
113-
- `MongoClient.create() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoClients.html#create(com.mongodb.MongoClientSettings)>`__
114-
- `ProxySettings.Builder <{+core-api+}/connection/ProxySettings.Builder.html>`__
113+
- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/index.html>`__
114+
- `ProxySettings.Builder
115+
<{+core-api+}/connection/ProxySettings.Builder.html>`__

‎source/fundamentals/databases-collections.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ Drop a Collection
171171
-----------------
172172

173173
You can remove a collection from the database using the
174-
`MongoCollection.drop()
175-
<{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#drop()>`__ method:
174+
`MongoCollection.drop() <{+driver-api+}/-mongo-collection/drop.html>`__
175+
method:
176176

177177
.. literalinclude:: /examples/generated/DatabaseCollectionsTest.snippet.drop-collections.kt
178178
:language: kotlin

‎source/index.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Fundamentals
7070
API Documentation
7171
-----------------
7272

73-
The MongoDB Kotlin driver API documentation contains several libraries
73+
The {+driver-short+} API documentation contains several libraries
7474
organized by functionality. For detailed information about classes and
7575
methods in each library, see the following table for their descriptions
7676
and links to the API documentation.
@@ -83,17 +83,20 @@ and links to the API documentation.
8383
* - Library
8484
- Description
8585

86+
* - `Kotlin Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>`__
87+
- Coroutine API
88+
8689
* - `BSON <{+api-root+}/bson/index.html>`__
8790
- Base BSON classes
8891

8992
* - `BSON Record Codec <{+api-root+}/bson-record-codec/index.html>`__
9093
- Classes that support records
9194

92-
* - `Core <{+api-root+}/mongodb-driver-core/index.html>`__
93-
- Shared core classes
95+
* - `Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html>`__
96+
- Classes that support using data classes with builders
9497

95-
* - `Kotlin Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>`__
96-
- API
98+
* - `Core <{+api-root+}/driver-core/index.html>`__
99+
- Shared core classes between JVM drivers
97100

98101
FAQ
99102
---

‎source/usage-examples/deleteMany.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ page, see the following API Documentation:
5454

5555
- `deleteMany() <{+driver-api+}/-mongo-collection/delete-many.html>`__
5656
- `DeleteResult <{+core-api+}/client/result/DeleteResult.html>`__
57-
- `drop() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#drop()>`__
57+
- `drop() <{+driver-api+}/-mongo-collection/drop.html>`__

‎source/whats-new.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ improvements, and fixes:
107107
- Support for using builders class methods directly with data class
108108
properties. To learn more, see the :ref:`kotlin-builders-data-classes`
109109
guide. This functionality is supported by the `{+driver-short+}
110-
Extensions package <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__
110+
Extensions package <{+api-root+}/driver-kotlin-extensions/index.html>`__
111111
published with this release.
112112

113113
- Implements a *client* bulk write API that allows you to perform write

0 commit comments

Comments
 (0)
0