[CXX-1018] Document production/API/ABI stability across branches Created: 07/Sep/16  Updated: 20/Dec/16  Resolved: 28/Sep/16

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

Type: Bug Priority: Critical - P2
Reporter: David Golden Assignee: David Golden
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The README.md implies the mongocxx driver is stable, which it is not.

There may be other places in the documentation or on the wiki that imply the same.

We need to make sure that all documentation sources clearly indicate the lack of API/ABI stability for the 3.x mongocxx series.



 Comments   
Comment by David Golden [ 28/Sep/16 ]

I've updated all the README files in the three main branches: master, legacy, 26compat

Comment by David Golden [ 21/Sep/16 ]

Addressed in https://github.com/mongodb/mongo-cxx-driver/pull/539 as part of CXX-1000.

Comment by Andrew Morrow (Inactive) [ 08/Sep/16 ]

There are three sorts of "stability" we want to document:

  • Is the driver considered suitable for production use?
  • Is the driver API stable?
  • Is the driver ABI stable?

I think we should update the README in all three branches with a more detailed table that captures the full spectrum of information we want to convey.

Comment by Andrew Morrow (Inactive) [ 08/Sep/16 ]

Note that the fix for this should apply to the README on all three branches.

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