Skip to content

Commit 956b3a4

Browse files
committed
MR feedback
1 parent 69fff45 commit 956b3a4

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

source/compatibility.txt

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ MongoDB. Except when indicated, the specified driver versions expose or
2626
take advantage of the features added in the corresponding server versions.
2727

2828
MongoDB server releases are generally backwards compatible. This means a
29-
particular driver version will generally work with newer server versions but may
29+
particular driver version will generally work with newer server versions but might
3030
not utilize the new functionalities in those server versions.
3131

3232
The first column lists the driver versions.
@@ -79,31 +79,33 @@ The {+driver-short+} uses the protocols supported by the underlying Ruby
7979
the functionality available in the operating system's OpenSSL library.
8080

8181
Industry best practices, and some regulations, require the use of TLS 1.1
82-
or newer. Some operating systems or versions may not provide an OpenSSL version
82+
or newer. Some operating systems or versions might not provide an OpenSSL version
8383
that supports these TLS versions.
8484

8585
If you use macOS older than 10.13 (High Sierra), you need to install Ruby from
8686
`rvm`_, `homebrew`_, `macports`_, or another similar source. See
8787
`Installing Ruby`_ for more options.
8888

89-
If you use Linux or other non-macOS Unix, you can check your OpenSSL version
89+
If you use Linux or other non-macOS Unix system, you can check your OpenSSL version
9090
as follows:
9191

9292
.. code-block:: sh
9393

94-
openssl version
94+
openssl version
9595

9696
If the version number is less than 1.0.1, support for TLS 1.1 or newer is
9797
not available. Contact your operating system vendor for a solution or upgrade
9898
to a newer distribution.
9999

100-
You can check your Ruby interpreter by running the following command:
100+
You can check your TLS version by running the following command in your Ruby
101+
interpreter:
101102

102103
.. code-block:: sh
103104

104-
ruby -e "require 'net/http'; require 'json'; puts JSON.parse(Net::HTTP.get(URI('https://www.howsmyssl.com/a/check')))['tls_version']"
105+
ruby -e "require 'net/http'; require 'json'; puts JSON.parse(Net::HTTP.get(URI('https://www.howsmyssl.com/a/check')))['tls_version']"
105106

106-
You should see ``TLS 1.X`` where ``X`` is greater than or equal to ``1``.
107+
After running the command, you must see ``TLS 1.X`` where ``X`` is greater than
108+
or equal to ``1``.
107109

108110
To learn more about TLS versions and their security implications, see `Transport Layer Security Cheat Sheet
109111
<https://cheatsheetseries.owasp.org/cheatsheets/Transport_Layer_Security_Cheat_Sheet.html>`_.
@@ -116,14 +118,12 @@ To learn more about TLS versions and their security implications, see `Transport
116118
Atlas Compatibility
117119
-------------------
118120

119-
We recommend `Driver version 2.6.1
120-
<https://github.com/mongodb/mongo-ruby-driver/releases/tag/v2.6.1>`_ or higher
121-
when using MongoDB Atlas. This version has significant performance improvements
122-
for TLS connections, and all Atlas connections use TLS.
121+
We recommend {+driver-short+} version 2.6.1 or higher when using MongoDB Atlas.
122+
This version has significant performance improvements for TLS connections, and
123+
all Atlas connections use TLS.
123124

124-
When running on JRuby and connecting to Atlas Free Tier,
125-
`driver version 2.6.4 <https://github.com/mongodb/mongo-ruby-driver/releases/tag/v2.6.4>`_
126-
or higher and Java 8 or higher are required.
125+
When running on JRuby and connecting to Atlas Free Tier, {+driver-short+}
126+
version 2.6.4 or higher and Java 8 or higher are required.
127127

128128
mongo_kerberos Compatibility
129129
----------------------------
@@ -147,12 +147,13 @@ the {+driver-short+}.
147147
JRuby and Kerberos Authentication
148148
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149149

150-
If you use the ``mongo_kerberos`` gem for Kerberos authentication with JRuby, the
151-
JVM system property ``sun.security.jgss.native`` is set to ``true`` to
150+
If you use the ``mongo_kerberos`` gem for Kerberos authentication with JRuby,
151+
the JVM system property ``sun.security.jgss.native`` is set to ``true``. This
152152
facilitate the use of the system cache of Ticket Granting Tickets (TGTs) (for
153-
example, TGTs obtained with ``kinit``). This setting also affects any other use
154-
of the JGSS library, making any TGTs in the system cache available for obtaining
155-
Kerberos credentials.
153+
example, TGTs obtained with ``kinit``).
154+
155+
This setting also affects any other use of the JGSS library, making any TGTs in
156+
the system cache available for obtaining Kerberos credentials.
156157

157158
.. include:: /includes/unicode-checkmark.rst
158159
.. include:: /includes/unicode-nbsp.rst

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Compatibility
105105
-------------
106106

107107
To learn about the versions of the {+mdb-server+} and the {+language+} language
108-
that are compatible with each version of the {+driver-short+}, see the
108+
that are compatible with each version of the {+driver-short+}, see the
109109
:ref:`Compatibility <ruby-compatibility>` section.
110110

111111
Developer Hub

0 commit comments

Comments
 (0)