[CXX-767] Write a wiki page about handling bson in the new driver Created: 04/Dec/15 Updated: 11/Jan/16 Resolved: 22/Dec/15 |
|
| Status: | Closed |
| Project: | C++ Driver |
| Component/s: | None |
| Affects Version/s: | 3.0.0-rc0 |
| Fix Version/s: | 3.0.0-rc0 |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Samantha Ritter (Inactive) | Assignee: | Samantha Ritter (Inactive) |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Epic Link: | C++11 Driver MongoDB 3.2 |
| Description |
|
Creating and handling bson objects in the new driver is very confusing. We should write a clear, detailed wiki page explaining the different types and when and how to use them. The view_and_value example that ships with the server is a little hard to find, and is not sufficient. |
| Comments |
| Comment by Samantha Ritter (Inactive) [ 22/Dec/15 ] |
|
Section added, article linked to the main wiki on the sidebar under "New Driver Docs" and underneath the Quickstart Guide. |
| Comment by Andrew Morrow (Inactive) [ 17/Dec/15 ] |
|
I think that looks really good. My one suggestion is that we should add some explanation around view_or_value, and show how it can be used to work around the issues raised in the "BSON Document Lifetime" section. Feel free to publish it as is though and then add the new section. Where do you want to link this on the main wiki? |
| Comment by Samantha Ritter (Inactive) [ 17/Dec/15 ] |
|
Sorry about that, here is a working link: https://github.com/mongodb/mongo-cxx-driver/wiki/Handling-BSON-in-the-new-driver |
| Comment by Andrew Morrow (Inactive) [ 11/Dec/15 ] |
|
samantha.ritter - That link just goes to an edit page for me. Can you check the link so we can review this? |
| Comment by Samantha Ritter (Inactive) [ 07/Dec/15 ] |
|
"code review" draft of a page is here, feel free to edit: Once it looks good I will add a link to it from the main wiki. |
| Comment by Adam Midvidy [ 04/Dec/15 ] |
|
I'm all for improving documentation. I do think that the examples should continue to be improved as well though (e.g. adding examples for the view_or_value type) |
| Comment by Adam Midvidy [ 04/Dec/15 ] |
|
the examples are decent currently. I think the easiest way to show is by example as the builders are very difficult to figure out how to use from reading the code. https://github.com/mongodb/mongo-cxx-driver/tree/master/examples/bsoncxx |