Skip to content

Commit 76cb126

Browse files
committed
RR feedback
1 parent 29f110a commit 76cb126

File tree

7 files changed

+424
-33
lines changed

7 files changed

+424
-33
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ php-library = "MongoDB PHP Library"
3535

3636
[constants]
3737
php-library = "MongoDB PHP Library"
38-
driver-short = "PHP library"
38+
library-short = "PHP library"
3939
stable-api = "Stable API"
4040
mdb-server = "MongoDB Server"
4141
api = "https://www.mongodb.com/docs/php-library/current/reference"

source/connect/client.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Overview
2222

2323
To connect to a MongoDB deployment, you must create the following items:
2424

25-
- **Connection URI**, also known as a *connection string*, which tells the {+driver-short+}
25+
- **Connection URI**, also known as a *connection string*, which tells the {+library-short+}
2626
which MongoDB deployment to connect to.
2727
- **MongoDB\\Client** object, which creates the connection to the MongoDB deployment
2828
and lets you perform operations on it.
2929

3030
You can also set options within either or both of these components to
31-
customize the way that the {+driver-short+} behaves
31+
customize the way that the {+library-short+} behaves
3232
while connected to MongoDB.
3333

3434
This guide describes the components of a connection string and shows how to
@@ -99,7 +99,7 @@ deployment on port ``27017`` of ``localhost``:
9999
API Documentation
100100
-----------------
101101

102-
To learn more about creating a ``MongoDB\Client`` object in the {+driver-short+},
102+
To learn more about creating a ``MongoDB\Client`` object in the {+library-short+},
103103
see the following API documentation:
104104

105105
- :ref:`MongoDB\Client <php-api-mongodbclient>`

source/connect/connection-targets.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ breaking changes when Atlas upgrades to a new version of {+mdb-server+}.
4242
To learn more about the {+stable-api+} feature, see the :ref:`{+stable-api+} page
4343
<php-stable-api>`.
4444

45-
The following code shows how to use the {+driver-short+} to connect to an Atlas cluster.
45+
The following code shows how to use the {+library-short+} to connect to an Atlas cluster.
4646
The code also uses the ``serverApi`` option to specify a {+stable-api+} version.
4747

4848
.. literalinclude:: /includes/connect/atlas.php
@@ -63,7 +63,7 @@ To connect to a local MongoDB deployment, use ``localhost`` as the hostname. By
6363
default, the ``mongod`` process runs on port 27017, though you can customize this for
6464
your deployment.
6565

66-
The following code shows how to use the {+driver-short+} to connect to a local MongoDB
66+
The following code shows how to use the {+library-short+} to connect to a local MongoDB
6767
deployment:
6868

6969
.. literalinclude:: /includes/connect/client.php
@@ -79,7 +79,7 @@ To connect to a replica set, specify the hostnames (or IP addresses) and
7979
port numbers of the replica set members in your connection string.
8080

8181
If you aren't able to provide a full list of hosts in the replica set, you can
82-
specify one or more of the hosts in the replica set and instruct the {+driver-short+} to
82+
specify one or more of the hosts in the replica set and instruct the {+library-short+} to
8383
perform automatic discovery to find the others. To instruct the driver to perform
8484
automatic discovery, choose one of the following actions:
8585

source/connect/tls.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Overview
2323
In this guide, you can learn how to use the :wikipedia:`TLS <Transport_Layer_Security>`
2424
protocol to secure your connection to a MongoDB deployment.
2525

26-
When you enable TLS for a connection, the {+driver-short+} performs the following actions:
26+
When you enable TLS for a connection, the {+library-short+} performs the following actions:
2727

2828
- Uses TLS to connect to the MongoDB deployment
2929
- Verifies the deployment's certificate
@@ -41,7 +41,7 @@ To learn how to configure your MongoDB deployment for TLS, see the
4141

4242
.. tip::
4343

44-
The {+driver-short+} delegates most TLS behavior to the MongoDB C Driver.
44+
The {+library-short+} delegates most TLS behavior to the MongoDB C Driver.
4545
For information about how the C driver handles TLS, including configuration steps
4646
and expected behavior, see
4747
`Configuring TLS <https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/guides/configuring_tls/#supported-libraries>`__
@@ -78,7 +78,7 @@ signed by a well-known CA (certificate authority), and your application relies o
7878
to validate the certificate.
7979

8080
During testing, however, you might want to act as your own CA.
81-
In this case, you must instruct the {+driver-short+} to
81+
In this case, you must instruct the {+library-short+} to
8282
use your CA certificates instead of ones signed by another CA.
8383

8484
To do so, use the ``tlsCAFile`` connection option to specify the path to a ``.pem`` file
@@ -95,7 +95,7 @@ Specify a CA Directory
9595

9696
If you are using OpenSSL or LibreSSL (``libtls``) for TLS support, you can also use
9797
the ``ca_dir`` option to instruct
98-
the {+driver-short+} to search for a CA file within a directory. The driver searches this
98+
the {+library-short+} to search for a CA file within a directory. The driver searches this
9999
directory if it doesn't find a CA file at the path specified in the ``tlsCAFile`` option.
100100

101101
The following code example shows how to use the ``driverOptions`` parameter to specify the
@@ -119,7 +119,7 @@ Check Certificate Revocation
119119
----------------------------
120120

121121
When an X.509 certificate is no longer trustworthy—for example, if its private key
122-
has been compromised—the CA revokes the certificate. The {+driver-short+} includes two ways
122+
has been compromised—the CA revokes the certificate. The {+library-short+} includes two ways
123123
to check whether a server's certificate has been revoked.
124124

125125
.. _php-disable-ocsp:
@@ -131,15 +131,15 @@ The Online Certificate Status Protocol (OCSP) process varies depending on the ve
131131
{+mdb-server+} you're connecting to:
132132

133133
- **MongoDB v4.4 or later:** The server staples a
134-
time-stamped OCSP response to its certificate. The {+driver-short+} validates the certificate
134+
time-stamped OCSP response to its certificate. The {+library-short+} validates the certificate
135135
against the OCSP response. If the CA has revoked the certificate, or if the OCSP response
136136
is otherwise invalid, the TLS handshake fails.
137-
- **MongoDB v4.3 or earlier:** The server supplies an OCSP endpoint, which the {+driver-short+}
138-
contacts directly. The {+driver-short+} then validates the certificate against the OCSP
137+
- **MongoDB v4.3 or earlier:** The server supplies an OCSP endpoint, which the {+library-short+}
138+
contacts directly. The {+library-short+} then validates the certificate against the OCSP
139139
response. If the CA hasn't revoked the certificate, the TLS handshake continues, even if
140140
the OCSP response is invalid or malformed.
141141

142-
To stop the {+driver-short+} from contacting the OCSP endpoint, set the
142+
To stop the {+library-short+} from contacting the OCSP endpoint, set the
143143
``tlsDisableOCSPEndpointCheck`` connection option to ``true``.
144144
You can do this in two ways: by passing an argument to the
145145
``MongoDB\Client`` constructor or through a parameter in your connection string.
@@ -148,15 +148,15 @@ You can do this in two ways: by passing an argument to the
148148

149149
.. note::
150150

151-
Even if the ``tlsDisableOCSPEndpointCheck`` option is set to ``true``, the {+driver-short+}
151+
Even if the ``tlsDisableOCSPEndpointCheck`` option is set to ``true``, the {+library-short+}
152152
still verifies any OCSP response stapled to a server's certificate.
153153

154154
.. _php-crl:
155155

156156
Certificate Revocation List
157157
~~~~~~~~~~~~~~~~~~~~~~~~~~~
158158

159-
Instead of using OCSP, you can use the instruct the {+driver-short+}
159+
Instead of using OCSP, you can use the instruct the {+library-short+}
160160
to check the server's certificate
161161
against a Certificate Revocation List (CRL) published by the CA. To do so, set the
162162
``crl_file`` option to the file path of the CRL. Include this option in the
@@ -177,7 +177,7 @@ Present a Client Certificate
177177
----------------------------
178178

179179
Some MongoDB deployments require every connecting application to present a client certificate
180-
that proves its identity. To specify the client certificate for the {+driver-short+} to
180+
that proves its identity. To specify the client certificate for the {+library-short+} to
181181
present, set the ``tleCertificateKeyFile`` option to the file path of the ``.pem`` file that
182182
contains your certificate and private key.
183183

@@ -214,7 +214,7 @@ of the ``MongoDB\Client`` constructor or through a parameter in your connection
214214
Allow Insecure TLS
215215
------------------
216216

217-
When TLS is enabled, the {+driver-short+} automatically verifies the certificate that
217+
When TLS is enabled, the {+library-short+} automatically verifies the certificate that
218218
the server presents. When testing your code, you can disable this verification.
219219
This is known as *insecure TLS.*
220220

@@ -262,7 +262,7 @@ To disable only hostname verification, set the ``tlsAllowInvalidHostnames`` opti
262262
API Documentation
263263
-----------------
264264

265-
To learn more about configuring TLS for the {+driver-short+},
265+
To learn more about configuring TLS for the {+library-short+},
266266
see the following API documentation:
267267

268268
- :phpclass:`MongoDB\Client`

source/data-formats.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Specialized Data Formats
3030
Overview
3131
--------
3232

33-
You can use several types of specialized data formats in your {+driver-short+}
33+
You can use several types of specialized data formats in your {+library-short+}
3434
application. To learn how to work with these data formats, see the following
3535
guides:
3636

source/index.txt

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ Overview
2929

3030
Welcome to the documentation site for the official {+php-library+}.
3131

32-
The {+driver-short+} provides a high-level abstraction around the lower-level
32+
The {+library-short+} provides a high-level abstraction around the lower-level
3333
:php:`mongodb extension <mongodb>`.
3434

3535
The ``mongodb`` extension provides a limited API to connect to a MongoDB
3636
database and execute generic commands, queries, and write operations. In
37-
contrast, the {+driver-short+} provides a full-featured API and models client,
37+
contrast, the {+library-short+} provides a full-featured API and models client,
3838
database, and collection objects. If you are developing a PHP application with
39-
MongoDB, consider using the {+driver-short+} instead of the extension alone.
39+
MongoDB, consider using the {+library-short+} instead of the extension alone.
4040

4141
Get Started
4242
-----------
@@ -53,7 +53,7 @@ in the :ref:`php-connect` section.
5353
Databases and Collections
5454
-------------------------
5555

56-
Learn how to use the {+driver-short+} to work with MongoDB databases and collections
56+
Learn how to use the {+library-short+} to work with MongoDB databases and collections
5757
in the :ref:`php-databases-collections` section.
5858

5959
Read Data from MongoDB
@@ -69,7 +69,7 @@ Learn how you can write data to MongoDB in the :ref:`php-write` section.
6969
Transform Your Data with Aggregation
7070
------------------------------------
7171

72-
Learn how to use the {+driver-short+} to perform aggregation operations in the
72+
Learn how to use the {+library-short+} to perform aggregation operations in the
7373
:ref:`php-aggregation` section.
7474

7575
Optimize Queries with Indexes
@@ -99,7 +99,7 @@ Learn how to work with specialized data formats and custom types in the
9999
Compatibility
100100
-------------
101101

102-
See compatibility tables showing the recommended {+driver-short+} version to use for
102+
See compatibility tables showing the recommended {+library-short+} version to use for
103103
specific PHP and {+mdb-server+} versions in the :ref:`php-compatibility` section.
104104

105105
What's New
@@ -109,13 +109,14 @@ Learn about new features and changes in each version in the :ref:`<php-lib-whats
109109
section.
110110

111111
.. TODO:
112-
Upgrade {+driver-short+} Versions
113-
---------------------------------
114-
Learn what changes you might need to make to your application to upgrade driver versions
115-
in the :ref:`php-upgrade` section.
112+
Upgrade {+library-short+} Versions
113+
----------------------------------
114+
115+
.. Learn what changes you must make to your application to upgrade driver versions
116+
.. in the :ref:`php-upgrade` section.
116117

117118
FAQ
118119
---
119120

120-
See answers to commonly asked questions about the {+driver-short+} in the
121+
See answers to commonly asked questions about the {+library-short+} in the
121122
the :ref:`php-faq` section.

0 commit comments

Comments
 (0)