[CXX-1898] Separate installation instructions into more discrete guides Created: 21/Dec/19  Updated: 28/Oct/23  Resolved: 31/Oct/20

Status: Closed
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.7.0, 3.7.0-beta1

Type: Improvement Priority: Major - P3
Reporter: Stennie Steneker (Inactive) Assignee: Roberto Sanchez
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on CXX-1587 Update "ref" syntax for modern Hugo Closed
Related
related to CXX-1962 Use cmake, not make/msbuild, in docum... Closed
related to CXX-2104 Document how to use C++ driver via CM... Backlog
related to CDRIVER-3703 Split installation instructions into ... Closed
Epic Link: CXX usability improvements

 Description   

The current driver installation instructions (http://mongocxx.org/mongocxx-v3/installation/) try to cover all permutations of O/S and beginner vs advanced use cases in a single document. This makes it challenging for end users to extract relevant instructions and there are also too many potential decisions to consider.

It would be helpful to split the instructions into more discrete guides such as:

  • Installing on Linux with GCC
  • Installing on MacOS with Clang
  • Installing on Windows 10 with Visual Studio

Each install guide could have streamlined default install steps with additional options listed later.



 Comments   
Comment by Githook User [ 31/Oct/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CXX-1898 separate installation instructions by platform
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/20324270d5133f0c829034cc67d90af3e5185330

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