Skip to content

PHPLIB-786: Rename "Versioned API" to "Stable API" in docs #888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 11, 2022
Merged

PHPLIB-786: Rename "Versioned API" to "Stable API" in docs #888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ name: serverApi
type: :php:`MongoDB\\Driver\\ServerApi <class.mongodb-driver-serverapi>`
description: |
Used to declare an API version on the client. See the
:manual:`Versioned API tutorial </tutorial/versioned-api>` for usage.
:manual:`Stable API tutorial </tutorial/stable-api>` for usage.

.. versionadded:: 1.9
interface: phpmethod
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Tutorials
/tutorial/indexes
/tutorial/tailable-cursor
/tutorial/example-data
/tutorial/versioned-api
/tutorial/stable-api
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mongodb/docs-platform Is there an easy way to implement a web redirect from versioned-api to stable-api? Or is this something the docs team would handle themselves in https://github.com/mongodb/docs-php-library?

I'm not terribly concerned about this, as I doubt we have many direct links to this tutorial out there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would normally be handled in the docs-php-library repo in the config/redirects file!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@schmalliso: Thanks, I'll make a note of this after merging and opening a DOCSP ticket requesting a deployment.

15 changes: 7 additions & 8 deletions docs/tutorial/versioned-api.txt → docs/tutorial/stable-api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=============
Versioned API
=============
==========
Stable API
==========

.. default-domain:: mongodb

Expand All @@ -10,7 +10,7 @@ Versioned API
:depth: 1
:class: singlecol

Declaring an API version
Declaring an API Version
------------------------

To declare an API version, pass a ``serverApi`` driver option when creating your
Expand Down Expand Up @@ -43,10 +43,9 @@ Strict API
----------

By default, declaring an API version guarantees behavior for commands that are
part of the versioned API, but does not forbid using commands that are not part
part of the stable API, but does not forbid using commands that are not part
of the API version. To only allow commands and options that are part of the
versioned API, specify the ``strict`` option when creating the
specify the ``strict`` option when creating the
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This appears to have been a typo dating back to the original commit for this page (21e7ecd).

stable API, specify the ``strict`` option when creating the
:php:`MongoDB\\Driver\\ServerApi <class.mongodb-driver-serverapi>` instance:

.. code-block:: php
Expand Down Expand Up @@ -83,7 +82,7 @@ testing to ensure a smooth transition to a future API version.

At the time of this writing, no part of API version "1" has been deprecated.

Usage with the command helper
Usage with the Command Helper
-----------------------------

When using the :phpmethod:`MongoDB\\Database::command()` method to run arbitrary
Expand Down