DRIVERS-2789 Clean up source file structure #1663
Conversation
blink1073
commented
Sep 23, 2024
blink1073
commented
- Update folder structure for markdown files so everything is in a folder
- Rename bson-related specs to group them
blink1073
requested review from
alcaeus,
dariakp,
aditi-khare-mongoDB,
nbbeeken,
katcharov and
a team
and removed request for
a team,
dariakp,
aditi-khare-mongoDB,
nbbeeken and
katcharov
blink1073
requested review from
dariakp and
aditi-khare-mongoDB
and removed request for
a team,
nbbeeken,
dariakp and
aditi-khare-mongoDB
|
source/bson-dbref/dbref.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| # Handling of DBRefs | |||
| # BSON DBRef | |||
There was a problem hiding this comment.
Nit: Looking at other "BSON <type>" specs, this suggests that DBRef is a BSON type, which it isn't. Any objections to just calling this the "DBRef spec"?
There was a problem hiding this comment.
Ah, right, I was confusing it with the deprecated DBPointer.
| @@ -2,9 +2,12 @@ | |||
|
|
|||
| - [Atlas Serverless Tests](serverless-testing/README.md) | |||
| - [Authentication](auth/auth.md) | |||
| - [BSON Binary Subtype 6](client-side-encryption/subtype6.md) | |||
| - [BSON Binary Encrypted](bson-binary-encrypted/binary-encrypted.md) | |||
There was a problem hiding this comment.
Similar to how we have multiple documents in the SDAM spec folder, how about moving all of the various BSON specs into a bson folder with an index document that links to the main BSON spec (https://bsonspec.org) and our own specifications?
There was a problem hiding this comment.
I'd want to leave BSON-corpus out of that move, at least in this PR, since drivers are keying in on paths to sync spec files. For #1658, we'd move the spec file into this new bson folder and put its spec files into their own binary-vector-tests folder?
There was a problem hiding this comment.
Haha, I meant that as a question. Should I make a source/bson folder and put the other bson- specs in it now?
There was a problem hiding this comment.
Oh, sorry. Yes, having a bson folder containing all of the various BSON specs makes sense, I'm also fine leaving the bson-corpus out for the time being until we know all of the references.
There could also be a single tests folder that contains the various tests (potentially in subfolders similar to how it's done for the CSFLE spec). Looking at #1658, the question is why those tests aren't added to the BSON corpus in the first place - was it a matter of grouping tests with the spec document?
There was a problem hiding this comment.
The tests are different from the standard corpus tests, because there is additional metadata in the BSON binary value. So I think we should keep these folders separate.
* DRIVERS-2789 Clean up source file structure * update links * update names * address review
