[CDRIVER-3703] Split installation instructions into platform specific pages Created: 04/Jun/20  Updated: 28/Oct/23  Resolved: 05/Sep/23

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.25.0

Type: Improvement Priority: Major - P3
Reporter: Kevin Albertson Assignee: Colby Pike
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to CXX-1898 Separate installation instructions in... Closed
Epic Link: CDRIVER-4546
Quarter: FY24Q1

 Description   

A user building the C driver from source should not need to look at the instructions for other platforms. I'm thinking of the following layout:

  • Installing
    • Supported Platforms
    • Install libmongoc with a Package Manager
    • Install libbson with a Package Manager

And have that top-level installation page link to the platform specific pages:

  • Building on Unix
  • Building on macOS
  • Building on Windows with Visual Studio
  • Building on Windows with MinGW
  • Advanced Installation Options
    • Additional Options for Integrators

And split the libbson-only instructions into libbson pages. We can reduce duplication with includes. But I think this will make the first touch with libmongoc/libbson better.



 Comments   
Comment by Kevin Albertson [ 05/Sep/23 ]

Resolved by: https://github.com/mongodb/mongo-c-driver/pull/1371

Generated at Wed Feb 07 21:18:48 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.