From 33b3d335f3f60abe349a12d84de3e0e5b0e96f63 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 4 Mar 2025 14:34:19 -0500 Subject: [PATCH 01/12] connect conflict --- source/connection.txt | 10 ++-------- source/connection/connect.txt | 6 +++--- .../connection/specify-connection-options.txt | 20 +++++++++++++++++++ .../connection-options.txt | 8 ++++---- .../{ => specify-connection-options}/jndi.txt | 0 .../mongoclientsettings.txt | 0 .../network-compression.txt | 0 .../stable-api.txt | 0 8 files changed, 29 insertions(+), 15 deletions(-) create mode 100644 source/connection/specify-connection-options.txt rename source/connection/{ => specify-connection-options}/connection-options.txt (98%) rename source/connection/{ => specify-connection-options}/jndi.txt (100%) rename source/connection/{ => specify-connection-options}/mongoclientsettings.txt (100%) rename source/connection/{ => specify-connection-options}/network-compression.txt (100%) rename source/connection/{ => specify-connection-options}/stable-api.txt (100%) diff --git a/source/connection.txt b/source/connection.txt index 47d48f2ff..9e3a6d0a7 100644 --- a/source/connection.txt +++ b/source/connection.txt @@ -6,15 +6,9 @@ Connection Guide .. toctree:: - Connect to MongoDB - Connection Options - MongoClient Settings - Stable API - Connection Pools - Network Compression - JNDI Datasource + Create a MongoClient + Specify Connection Options Connection Troubleshooting - AWS Lambda .. contents:: On this page :local: diff --git a/source/connection/connect.txt b/source/connection/connect.txt index a8e4c8169..b365e432d 100644 --- a/source/connection/connect.txt +++ b/source/connection/connect.txt @@ -1,8 +1,8 @@ .. _java-connect-to-mongodb: -================== -Connect to MongoDB -================== +==================== +Create a MongoClient +==================== .. contents:: On this page :local: diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt new file mode 100644 index 000000000..c04a29777 --- /dev/null +++ b/source/connection/specify-connection-options.txt @@ -0,0 +1,20 @@ +========================== +Specify Connection Options +========================== + +.. toctree:: + + Connection URI Options + MongoClient Settings + Stable API + Network Compression + JNDI Datasource + AWS Lambda + Enable TLS/SSL + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: connection string, URI, Atlas, code example \ No newline at end of file diff --git a/source/connection/connection-options.txt b/source/connection/specify-connection-options/connection-options.txt similarity index 98% rename from source/connection/connection-options.txt rename to source/connection/specify-connection-options/connection-options.txt index d2b20c693..3ce906a5d 100644 --- a/source/connection/connection-options.txt +++ b/source/connection/specify-connection-options/connection-options.txt @@ -1,12 +1,12 @@ .. _java-connection-options: .. _connection-options: -================== -Connection Options -================== +====================== +Connection URI Options +====================== This section explains MongoDB connection and authentication options -supported by the driver. You can pass the connection options as +supported by the {+driver-short+}. You can pass the connection options as parameters of the connection URI to specify the behavior of the client. .. list-table:: diff --git a/source/connection/jndi.txt b/source/connection/specify-connection-options/jndi.txt similarity index 100% rename from source/connection/jndi.txt rename to source/connection/specify-connection-options/jndi.txt diff --git a/source/connection/mongoclientsettings.txt b/source/connection/specify-connection-options/mongoclientsettings.txt similarity index 100% rename from source/connection/mongoclientsettings.txt rename to source/connection/specify-connection-options/mongoclientsettings.txt diff --git a/source/connection/network-compression.txt b/source/connection/specify-connection-options/network-compression.txt similarity index 100% rename from source/connection/network-compression.txt rename to source/connection/specify-connection-options/network-compression.txt diff --git a/source/connection/stable-api.txt b/source/connection/specify-connection-options/stable-api.txt similarity index 100% rename from source/connection/stable-api.txt rename to source/connection/specify-connection-options/stable-api.txt From ca206315703f68d8773c032771b90bbdc783dc81 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 4 Mar 2025 09:06:53 -0500 Subject: [PATCH 02/12] security pages --- source/connection/specify-connection-options.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt index c04a29777..2f202002e 100644 --- a/source/connection/specify-connection-options.txt +++ b/source/connection/specify-connection-options.txt @@ -4,13 +4,14 @@ Specify Connection Options .. toctree:: - Connection URI Options MongoClient Settings + Connection URI Options Stable API Network Compression JNDI Datasource AWS Lambda Enable TLS/SSL + Use a SOCKS5 Proxy .. facet:: :name: genre From 9db0b057d6bb0a9f27904763431249d031f73ed4 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 4 Mar 2025 10:35:33 -0500 Subject: [PATCH 03/12] connection security --- snooty.toml | 1 + .../connection/specify-connection-options.txt | 3 +-- .../security-connection-options.txt | 20 +++++++++++++++++++ source/security.txt | 16 ++++++++++++++- 4 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 source/connection/specify-connection-options/security-connection-options.txt diff --git a/snooty.toml b/snooty.toml index 5c13d89a4..ab77ef3b2 100644 --- a/snooty.toml +++ b/snooty.toml @@ -13,6 +13,7 @@ toc_landing_pages = [ "/crud/builders", "/data-formats", "/api-documentation", + "/security", "/security/auth" ] diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt index 2f202002e..384cdbc84 100644 --- a/source/connection/specify-connection-options.txt +++ b/source/connection/specify-connection-options.txt @@ -10,8 +10,7 @@ Specify Connection Options Network Compression JNDI Datasource AWS Lambda - Enable TLS/SSL - Use a SOCKS5 Proxy + Connection Security Settings .. facet:: :name: genre diff --git a/source/connection/specify-connection-options/security-connection-options.txt b/source/connection/specify-connection-options/security-connection-options.txt new file mode 100644 index 000000000..052b20a34 --- /dev/null +++ b/source/connection/specify-connection-options/security-connection-options.txt @@ -0,0 +1,20 @@ +.. _security-connection-settings: + +============================ +Connection Security Settings +============================ + +.. facet:: + :name: genre + :values: reference + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +MongoDB supports many options for securing your data before and during +transportation. For information about security options, see our :ref:`Security +section `, including :ref:`TLS/SSL ` and :ref:`SOCKS5 Proxy +` options. \ No newline at end of file diff --git a/source/security.txt b/source/security.txt index 96762b1a6..6c93d0f07 100644 --- a/source/security.txt +++ b/source/security.txt @@ -1,3 +1,5 @@ +.. _java-security: + ======== Security ======== @@ -13,4 +15,16 @@ Security In-Use Encryption TLS/SSL SOCKS5 Proxy - Validate Driver Artifact Signatures \ No newline at end of file + Validate Driver Artifact Signatures + +Overview +-------- + +Learn how to set up security options for your application in the following +sections: + +- :ref:`Authentication ` +- :ref:`In-Use Encryption ` +- :ref:`TLS/SSL ` +- :ref:`SOCKS5 Proxy ` +- :ref:`Validate Driver Artifact Signatures ` \ No newline at end of file From 1011afe3cd8a76cfa75a1925ae9d5d54628eca37 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 4 Mar 2025 13:17:48 -0500 Subject: [PATCH 04/12] landing pages --- snooty.toml | 1 + .../specify-connection-options/security-connection-options.txt | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index ab77ef3b2..440c0d579 100644 --- a/snooty.toml +++ b/snooty.toml @@ -9,6 +9,7 @@ intersphinx = [ toc_landing_pages = [ "/get-started", "/connection", + "/connection/specify-security-options", "/crud", "/crud/builders", "/data-formats", diff --git a/source/connection/specify-connection-options/security-connection-options.txt b/source/connection/specify-connection-options/security-connection-options.txt index 052b20a34..bfcc7f148 100644 --- a/source/connection/specify-connection-options/security-connection-options.txt +++ b/source/connection/specify-connection-options/security-connection-options.txt @@ -16,5 +16,5 @@ Connection Security Settings MongoDB supports many options for securing your data before and during transportation. For information about security options, see our :ref:`Security -section `, including :ref:`TLS/SSL ` and :ref:`SOCKS5 Proxy +section `, which includes :ref:`TLS/SSL ` and :ref:`SOCKS5 Proxy ` options. \ No newline at end of file From 87a964b726a2f786e8d0c469fb84e6e1924787bb Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 4 Mar 2025 14:57:37 -0500 Subject: [PATCH 05/12] snooty --- snooty.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 440c0d579..e550a15d9 100644 --- a/snooty.toml +++ b/snooty.toml @@ -9,7 +9,7 @@ intersphinx = [ toc_landing_pages = [ "/get-started", "/connection", - "/connection/specify-security-options", + "/connection/specify-connection-options", "/crud", "/crud/builders", "/data-formats", From 63eb1c978fa3a794ceddec1f7caa848533253fa1 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 4 Mar 2025 15:38:46 -0500 Subject: [PATCH 06/12] secrurity options landing page --- source/connection/specify-connection-options.txt | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt index 384cdbc84..b4cb5ff97 100644 --- a/source/connection/specify-connection-options.txt +++ b/source/connection/specify-connection-options.txt @@ -17,4 +17,13 @@ Specify Connection Options :values: reference .. meta:: - :keywords: connection string, URI, Atlas, code example \ No newline at end of file + :keywords: connection string, URI, Atlas, code example + + +- :ref:`MongoClient Settings ` +- :ref:`Connection URI Options ` +- :ref:`Stable API ` +- :ref:`Network Compression ` +- :ref:`JNDI Datasource ` +- :ref:`AWS Lambda ` +- :ref:`Connection Security Options ` \ No newline at end of file From 680da1ede83a689a2a1b32a279e621e5757c3869 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 11 Mar 2025 10:08:10 -0400 Subject: [PATCH 07/12] NR feedback --- config/redirects | 2 +- source/connection.txt | 13 ++++--------- source/connection/{connect.txt => mongoclient.txt} | 1 + source/connection/specify-connection-options.txt | 6 ++++-- .../security-connection-options.txt | 5 +++-- source/includes/security/security-pages.rst | 5 +++++ source/security.txt | 6 +----- 7 files changed, 19 insertions(+), 19 deletions(-) rename source/connection/{connect.txt => mongoclient.txt} (99%) create mode 100644 source/includes/security/security-pages.rst diff --git a/config/redirects b/config/redirects index 41ebcfd26..9bcc1f451 100644 --- a/config/redirects +++ b/config/redirects @@ -43,7 +43,7 @@ raw: ${prefix}/master -> ${base}/upcoming/ [v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ [v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/mongoclient [v5.3-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ diff --git a/source/connection.txt b/source/connection.txt index 9e3a6d0a7..1735b43de 100644 --- a/source/connection.txt +++ b/source/connection.txt @@ -6,7 +6,7 @@ Connection Guide .. toctree:: - Create a MongoClient + Create a MongoClient Specify Connection Options Connection Troubleshooting @@ -23,14 +23,9 @@ Learn how to set up a connection and specify connection behavior from your application to a MongoDB deployment using the driver in the following sections: -- :ref:`Connect to MongoDB ` -- :ref:`View a List of Connection Options ` -- :ref:`Specify Connection Behavior with the MongoClient Class ` -- :ref:`Enable Network Compression ` -- :ref:`Enable TLS/SSL on a Connection ` -- :ref:`Connect to MongoDB by Using a SOCKS5 Proxy ` -- :ref:`Connect to MongoDB by Using a JNDI Datasource ` -- :atlas:`Connect to MongoDB Atlas from AWS Lambda ` +- :ref:`Create a MongoClient ` +- :ref:`Specify Connection Options ` +- :ref:`Connection Troubleshooting ` For information about authenticating with a MongoDB instance, see the :ref:`` section. diff --git a/source/connection/connect.txt b/source/connection/mongoclient.txt similarity index 99% rename from source/connection/connect.txt rename to source/connection/mongoclient.txt index b365e432d..e280a1f9f 100644 --- a/source/connection/connect.txt +++ b/source/connection/mongoclient.txt @@ -1,4 +1,5 @@ .. _java-connect-to-mongodb: +.. _java-mongoclient: ==================== Create a MongoClient diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt index b4cb5ff97..1855d38a1 100644 --- a/source/connection/specify-connection-options.txt +++ b/source/connection/specify-connection-options.txt @@ -1,3 +1,5 @@ +.. _java-connection-options: + ========================== Specify Connection Options ========================== @@ -25,5 +27,5 @@ Specify Connection Options - :ref:`Stable API ` - :ref:`Network Compression ` - :ref:`JNDI Datasource ` -- :ref:`AWS Lambda ` -- :ref:`Connection Security Options ` \ No newline at end of file +- `AWS Lambda ` +- :ref:`Connection Security Options ` \ No newline at end of file diff --git a/source/connection/specify-connection-options/security-connection-options.txt b/source/connection/specify-connection-options/security-connection-options.txt index bfcc7f148..5b55044b0 100644 --- a/source/connection/specify-connection-options/security-connection-options.txt +++ b/source/connection/specify-connection-options/security-connection-options.txt @@ -16,5 +16,6 @@ Connection Security Settings MongoDB supports many options for securing your data before and during transportation. For information about security options, see our :ref:`Security -section `, which includes :ref:`TLS/SSL ` and :ref:`SOCKS5 Proxy -` options. \ No newline at end of file +section `, which includes: + +.. include:: /includes/security/security-pages.rst \ No newline at end of file diff --git a/source/includes/security/security-pages.rst b/source/includes/security/security-pages.rst new file mode 100644 index 000000000..e0e9116f1 --- /dev/null +++ b/source/includes/security/security-pages.rst @@ -0,0 +1,5 @@ +- :ref:`Authentication ` +- :ref:`In-Use Encryption ` +- :ref:`TLS/SSL ` +- :ref:`SOCKS5 Proxy ` +- :ref:`Validate Driver Artifact Signatures ` \ No newline at end of file diff --git a/source/security.txt b/source/security.txt index 6c93d0f07..15a5d2a07 100644 --- a/source/security.txt +++ b/source/security.txt @@ -23,8 +23,4 @@ Overview Learn how to set up security options for your application in the following sections: -- :ref:`Authentication ` -- :ref:`In-Use Encryption ` -- :ref:`TLS/SSL ` -- :ref:`SOCKS5 Proxy ` -- :ref:`Validate Driver Artifact Signatures ` \ No newline at end of file +.. include:: /includes/security/security-pages.rst \ No newline at end of file From c2d9c76da7f8ef9d8bed04d4d86c1ce4f60fc5b7 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 11 Mar 2025 10:32:17 -0400 Subject: [PATCH 08/12] build errors --- source/connection.txt | 2 +- source/connection/connection-troubleshooting.txt | 2 +- source/connection/specify-connection-options.txt | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/connection.txt b/source/connection.txt index 1735b43de..a5b5254d3 100644 --- a/source/connection.txt +++ b/source/connection.txt @@ -24,7 +24,7 @@ application to a MongoDB deployment using the driver in the following sections: - :ref:`Create a MongoClient ` -- :ref:`Specify Connection Options ` +- :ref:`Specify Connection Options ` - :ref:`Connection Troubleshooting ` For information about authenticating with a MongoDB instance, diff --git a/source/connection/connection-troubleshooting.txt b/source/connection/connection-troubleshooting.txt index 79315612f..d678ae409 100644 --- a/source/connection/connection-troubleshooting.txt +++ b/source/connection/connection-troubleshooting.txt @@ -245,7 +245,7 @@ against the connected secondary node if you set the read preference to You can also specify the ``serverSelectionTimeoutMS`` connection option to adjust the amount of time in which the driver must select a server. To -learn more, see the :ref:`java-connection-options` guide. +learn more, see the :ref:`java-connection-uri-options` guide. .. _java-miscellaneous-errors: diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt index 1855d38a1..c9b63fdbc 100644 --- a/source/connection/specify-connection-options.txt +++ b/source/connection/specify-connection-options.txt @@ -1,4 +1,4 @@ -.. _java-connection-options: +.. _java-specify-connection-options: ========================== Specify Connection Options @@ -27,5 +27,5 @@ Specify Connection Options - :ref:`Stable API ` - :ref:`Network Compression ` - :ref:`JNDI Datasource ` -- `AWS Lambda ` +- `AWS Lambda `__ - :ref:`Connection Security Options ` \ No newline at end of file From d6c33a56709b38bdbdbf6999e1da66aeede32083 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 11 Mar 2025 10:40:39 -0400 Subject: [PATCH 09/12] label --- source/connection.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connection.txt b/source/connection.txt index a5b5254d3..1f8cdbdb8 100644 --- a/source/connection.txt +++ b/source/connection.txt @@ -1,4 +1,4 @@ -.. _java-connection-guide: +.. _java-connection-uri-guide: ================ Connection Guide From 6bfed26506b3d0adc70b5f5f8b5884561148b5c6 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Tue, 11 Mar 2025 14:48:32 -0400 Subject: [PATCH 10/12] label fix --- .../specify-connection-options/connection-options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connection/specify-connection-options/connection-options.txt b/source/connection/specify-connection-options/connection-options.txt index 3ce906a5d..2c2d0e862 100644 --- a/source/connection/specify-connection-options/connection-options.txt +++ b/source/connection/specify-connection-options/connection-options.txt @@ -1,4 +1,4 @@ -.. _java-connection-options: +.. _java-connection-uri-options: .. _connection-options: ====================== From 269e330468b399551059828c7e541defbaaf55ae Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Wed, 12 Mar 2025 10:48:39 -0400 Subject: [PATCH 11/12] NR feedback --- .../specify-connection-options/security-connection-options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connection/specify-connection-options/security-connection-options.txt b/source/connection/specify-connection-options/security-connection-options.txt index 5b55044b0..22af0fdb9 100644 --- a/source/connection/specify-connection-options/security-connection-options.txt +++ b/source/connection/specify-connection-options/security-connection-options.txt @@ -16,6 +16,6 @@ Connection Security Settings MongoDB supports many options for securing your data before and during transportation. For information about security options, see our :ref:`Security -section `, which includes: +section `, which includes the following: .. include:: /includes/security/security-pages.rst \ No newline at end of file From a2775cd32b9919c48694859c388d7eeeef3f2005 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Wed, 12 Mar 2025 14:07:08 -0400 Subject: [PATCH 12/12] force rebuild