-
Type: New Feature
-
Resolution: Unresolved
-
Priority: Major - P3
-
None
-
Affects Version/s: None
-
Component/s: Documentation
-
Labels:
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).