[CXX-1326] Rewrite "Getting help" documentation page Created: 25/Apr/17  Updated: 07/Feb/24

Status: Backlog
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: New Feature Priority: Major - P3
Reporter: J Rassi Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: neweng
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: Reference Docs Improvements
Quarter: FY24Q3

 Description   

The "Getting help" section of the C++ driver manual is currently quite sparse. It would be a natural place to put several kinds of useful resources:

  • A troubleshooting guide, with a checklist of steps to follow for commonly encountered driver issues. e.g. "Symptom: I get a 'fatal error: 'bsoncxx/builder/basic/document.hpp' file not found' error when compiling my application. / Solution: - Step 1: Check the include flags on your compile line (<additional information here about how to find the compile line and what the the include flag should look like with the user's toolchain>)...". We should make sure that deleting the build directory is included on the troubleshooting checklists for building the driver.
  • A more generic mongocxx FAQ. It'd be useful for us to throw answers to frequently-asked questions here which don't (yet) have a natural home elsewhere in the documentation.
  • A "how to ask for help" resource. We can liberally copy from the existing legacy driver resource: https://mongodb.github.io/mongo-cxx-driver/legacy-v1/installation/#how-to-ask-for-help.

In addition, we should also add a prominent link (or links) to the "Getting help" page from the installation docs (since users often need help compiling/installing the driver).


Generated at Wed Feb 07 22:02:12 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.