[DRIVERS-2187] Rename "Versioned API" to "Stable API" in documentation Created: 03/Feb/22  Updated: 07/Apr/22  Resolved: 07/Apr/22

Status: Closed
Project: Drivers
Component/s: Docs
Fix Version/s: None

Type: Task Priority: Blocker - P1
Reporter: Bernie Hackett Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split to CDRIVER-4287 Rename "Versioned API" to "Stable API... Closed
split to CSHARP-4042 Rename "Versioned API" to "Stable API... Closed
split to CXX-2446 Rename "Versioned API" to "Stable API... Closed
split to GODRIVER-2301 Rename "Versioned API" to "Stable API... Closed
split to MOTOR-886 Rename "Versioned API" to "Stable API... Closed
split to PYTHON-3111 Rename "Versioned API" to "Stable API... Closed
split to RUBY-2898 Rename "Versioned API" to "Stable API... Closed
split to RUST-1173 Rename "Versioned API" to "Stable API... Closed
split to PHPLIB-786 Rename "Versioned API" to "Stable API... Closed
split to NODE-3969 Rename "Versioned API" to "Stable API... Closed
Related
related to DRIVERS-2216 Rename "Versioned API" spec to "Stabl... Backlog
related to DRIVERS-2203 Rename "Versioned API" spec to "Stabl... Closed
Driver Changes: Needed
Downstream Changes Summary:

NA

Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4287 Works as Designed
CXX-2446 Works as Designed
CSHARP-4042 Fixed 2.16.0
GODRIVER-2301 Done 1.9.0
NODE-3969 Done
MOTOR-886 Fixed 3.0
PYTHON-3111 Fixed 4.1
PHPLIB-786 Fixed 1.12.0
RUBY-2898 Won't Do
RUST-1173 Fixed 2.2.0
SWIFT-1483 Fixed 1.3.0

 Description   

To match the work tracked in DOCSP-20582 for DBX project docs not owned by the docs team. For example, on this page in PyMongo's docs we would change instances of "Versioned" to "Stable".

https://pymongo.readthedocs.io/en/stable/api/pymongo/server_api.html

See also DOCSP-20542.

I've set the priority to blocker to indicate this must be done for the next release of each DBX project affected.



 Comments   
Comment by Jeremy Mikola [ 11/Feb/22 ]

behackett: Will there be a separate ticket to rename https://github.com/mongodb/specifications/tree/master/source/versioned-api and corresponding test files, or is that not a concern?

Comment by Jeremy Mikola [ 11/Feb/22 ]

jeffrey.allen: DRIVERS-1741 and DRIVERS-1846 previously asked drivers to create documentation examples, which are delimited with "Start/End Versioned API Example <number>" comments.

Am I correct to assume that drivers should just leave those comments as-is for now, since the docs team likely hasn't updated their parsing scripts? Furthermore, I expect any parsing changes would need to accept either "Versioned API" or "Stable API" until all drivers have a chance to update their comments to the new terminology. If you intend to create a task to revise the parsing rules, please associate that ticket with the DRIVERS project (if not this issue then a new one) for visibility. Thanks.

Generated at Thu Feb 08 08:24:57 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.