[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: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Changes: | Needed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Downstream Changes Summary: | NA |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Compliance: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |