DOCPS-41150: Specialized Data Formats + BSON #19
Conversation
👷 Deploy request for docs-kotlin-sync pending review.Visit the deploys page to approve it
|
source/data-formats.txt
Outdated
| Overview | ||
| -------- | ||
|
|
||
| You can use several types of specialized data formats in your {+driver-short+} |
There was a problem hiding this comment.
| You can use several types of specialized data formats in your {+driver-short+} | |
| You can use several types of specialized document data formats in your {+driver-short+} |
| Overview | ||
| -------- | ||
|
|
||
| In this guide, you can learn about the BSON data format, how MongoDB |
There was a problem hiding this comment.
Q: How MongoDB uses it feels a little vague to me. How about something like:
"How MongoDB uses BSON to organize and store data"?
source/data-formats/bson.txt
Outdated
|
|
||
| **BSON**, or Binary JSON, is the data format that MongoDB uses to organize | ||
| and store data. This data format includes all JSON data structure types and | ||
| adds support for types including dates, differently-sized integers, ObjectIds, and |
There was a problem hiding this comment.
Q: I am unsure what differently-sized integers means in this context. Integers that are too big for regular JSON types?
There was a problem hiding this comment.
It refers to 32 and 64 bit integers.
There was a problem hiding this comment.
It could be good to state that explicitly
source/data-formats/bson.txt
Outdated
| binary data. For a complete list of supported types, see the | ||
| :manual:`BSON Types </reference/bson-types>` server manual page. | ||
|
|
||
| The binary format is not human-readable, but you can use the |
There was a problem hiding this comment.
| The binary format is not human-readable, but you can use the | |
| BSON is not human-readable, but you can use the |
source/data-formats/bson.txt
Outdated
| and store data. This data format includes all JSON data structure types and | ||
| adds support for types including dates, differently-sized integers, ObjectIds, and | ||
| binary data. For a complete list of supported types, see the | ||
| :manual:`BSON Types </reference/bson-types>` server manual page. |
There was a problem hiding this comment.
| :manual:`BSON Types </reference/bson-types>` server manual page. | |
| see :manual:`BSON Types </reference/bson-types>` in the MongoDB Server documentation. |
source/data-formats/bson.txt
Outdated
| MongoDB and BSON | ||
| ---------------- | ||
|
|
||
| You can use BSON data with your {+driver-short+} application by using one of the |
There was a problem hiding this comment.
S: "You can use...using" feels like a lot of "use". How about:
You can work with BSON data in your {+driver-short+} application by using...
|
|
||
| .. note:: | ||
|
|
||
| If you have already added the {+driver-short+} as a dependency to your |
There was a problem hiding this comment.
Q: I'm a little confused on the use case where a user would not have the driver installed but would need to install just the BSON library as a dependency, given that this page talks about using BSON with the user's Kotlin sync application
There was a problem hiding this comment.
This is a good question – I'm not sure why the other driver versions of this page have this section. I can raise it to the team at large to see if anyone has context.
There was a problem hiding this comment.
Update: There have been cases where developers are interested in this.
Although developers who find this page after they've already been in the Kotlin docs might not need this, it could be helpful for developers who find the docs through external sources (e.g. googling).
source/data-formats/bson.txt
Outdated
|
|
||
| We recommend that you use the `Maven <https://maven.apache.org/>`__ or | ||
| `Gradle <https://gradle.org/>`__ build automation tool to manage your {+language+} | ||
| project's dependencies. Select from the following tabs to see the dependency declaration |
There was a problem hiding this comment.
Q: I'm not sure if you need the sentence "Select from the following tabs...", as it seems to be pretty clear which tab does what/how users would get to a certain tab.
S: Remove the sentence
There was a problem hiding this comment.
I think there should still be some sort of introduction to the tabbed instructions so I'm opposed to removing the sentence outright, but I can tweak it to be a little more natural-sounding.
(cherry picked from commit 6bb165f)
(cherry picked from commit 6bb165f)
Based off this Kotlin Coroutine BSON page
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-41150 and https://jira.mongodb.org/browse/DOCSP-41151
Staging -
Self-Review Checklist