Skip to content

Commit ef9c268

Browse files
authored
DRIVERS-2789 Clean up source file structure (#1663)
* DRIVERS-2789 Clean up source file structure * update links * update names * address review
1 parent 30b3a75 commit ef9c268

File tree

31 files changed

+73
-70
lines changed

31 files changed

+73
-70
lines changed

source/client-side-encryption/subtype6.md renamed to source/bson-binary-encrypted/binary-encrypted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BSON Binary Subtype 6
1+
# BSON Binary Encrypted
22

33
- Status: Accepted
44
- Minimum Server Version: 4.2

source/uuid.md renamed to source/bson-binary-uuid/uuid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Handling of Native UUID Types
1+
# BSON Binary UUID
22

33
- Status: Accepted
44
- Minimum Server Version: N/A

source/bson-corpus/bson-corpus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ pseudo-specification provides such tests.
3737
## Specification
3838

3939
The specification for BSON lives at <http://bsonspec.org>. The `extjson` format specification is
40-
[here](../extended-json.md).
40+
[here](../extended-json/extended-json.md).
4141

4242
## Test Plan
4343

source/bson-decimal128/decimal128.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BSON Decimal128 Type Handling in Drivers
1+
# BSON Decimal128
22

33
- Status: Accepted
44
- Minimum Server Version: 3.4

source/objectid.md renamed to source/bson-objectid/objectid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ObjectID format
1+
# BSON ObjectID
22

33
- Status: Accepted
44
- Minimum Server Version: N/A

source/client-side-encryption/client-side-encryption.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ A local process the driver communicates with to determine how to encrypt values
9999

100100
This term, spelled in all-lowercase with an underscore, refers to the client-side field-level-encryption dynamic library
101101
provided as part of a MongoDB Enterprise distribution. It replaces [mongocryptd](#mongocryptd) as the method of
102-
[marking-up a database command for encryption](./subtype6.md#intent-to-encrypt).
102+
[marking-up a database command for encryption](../bson-binary-encrypted/binary-encrypted.md#intent-to-encrypt).
103103

104104
See also:
105105

@@ -108,8 +108,8 @@ See also:
108108

109109
**ciphertext**
110110

111-
One of the data formats of [BSON binary subtype 6](./subtype6.md), representing an encoded BSON document containing
112-
encrypted ciphertext and metadata.
111+
One of the data formats of [BSON binary encrypted](../bson-binary-encrypted/binary-encrypted.md), representing an
112+
encoded BSON document containing encrypted ciphertext and metadata.
113113

114114
**FLE**
115115

@@ -258,7 +258,7 @@ connect to [mongocryptd](#mongocryptd) and instead rely on [crypt_shared](#crypt
258258

259259
[crypt_shared](#crypt_shared) is a dynamically-loaded C++ library providing query analysis for auto-encryption. It
260260
replaces [mongocryptd](#mongocryptd) for performing query analysis to -
261-
[mark-up sensitive fields within a command](./subtype6.md#intent-to-encrypt).
261+
[mark-up sensitive fields within a command](../bson-binary-encrypted/binary-encrypted.md#intent-to-encrypt).
262262

263263
Drivers are not required to load and interact with [crypt_shared](#crypt_shared) directly. Instead, they inform
264264
[libmongocrypt](#libmongocrypt) where to find [crypt_shared](#crypt_shared) and [libmongocrypt](#libmongocrypt) will
@@ -305,7 +305,7 @@ Drivers MAY deviate the spelling of option names to conform to their language's
305305
in an idiomatic way (e.g. keyword arguments, builder classes, etc.).
306306

307307
Drivers MAY use a native UUID type in place of a parameter or return type specified as a BSON binary with subtype 0x04
308-
as described in [Handling of Native UUID Types](../uuid.md).
308+
as described in [Handling of Native UUID Types](../bson-binary-uuid/uuid.md).
309309

310310
### MongoClient Changes
311311

@@ -1791,7 +1791,7 @@ struct {
17911791
}
17921792
```
17931793

1794-
See [Driver Spec: BSON Binary Subtype 6](./subtype6.md) for more information.
1794+
See [Driver Spec: BSON Binary Encrypted](../bson-binary-encrypted/binary-encrypted.md) for more information.
17951795

17961796
### JSONSchema "encrypt"
17971797

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11

22
.. note::
33
This specification has been converted to Markdown and renamed to
4-
`subtype6.md <subtype6.md>`_.
4+
`subtype6.md <../bson-binary-encrypted/binary-encrypted.md>`_.

source/client-side-operations-timeout/client-side-operations-timeout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ The `timeoutMS` option applies to all operations defined in the following specif
9191
- [CRUD](../crud/crud.md)
9292
- [Change Streams](../change-streams/change-streams.md)
9393
- [Client Side Encryption](../client-side-encryption/client-side-encryption.md)
94-
- [Enumerating Collections](../enumerate-collections.md)
95-
- [Enumerating Databases](../enumerate-databases.md)
94+
- [Enumerating Collections](../enumerate-collections/enumerate-collections.md)
95+
- [Enumerating Databases](../enumerate-databases/enumerate-databases.md)
9696
- [GridFS](../gridfs/gridfs-spec.md)
9797
- [Index Management](../index-management/index-management.md)
9898
- [Transactions](../transactions/transactions.md)

source/crud/bulk-write.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -505,8 +505,8 @@ operation should be performed as its value. The documents have the following for
505505
}
506506
```
507507

508-
If the document to be inserted does not contain an `_id` field, drivers MUST generate a new [`ObjectId`](../objectid.md)
509-
and add it as the `_id` field at the beginning of the document.
508+
If the document to be inserted does not contain an `_id` field, drivers MUST generate a new
509+
[`ObjectId`](../bson-objectid/objectid.md) and add it as the `_id` field at the beginning of the document.
510510

511511
#### Update
512512

source/dbref.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11

22
.. note::
33
This specification has been converted to Markdown and renamed to
4-
`dbref.md <dbref.md>`_.
4+
`dbref.md <bson-dbref/dbref.md>`_.

0 commit comments

Comments
 (0)