Skip to content
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

Jump to bottom

DOCSP-44514 Add links to connection landing page #71

Merged
merged 2 commits into from
Oct 16, 2024
Merged

DOCSP-44514 Add links to connection landing page #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bf4f20
Add links to connection landing page
jordan-smith721 Oct 16, 2024
87b991a
full page title in link
jordan-smith721 Oct 16, 2024
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
28 changes: 17 additions & 11 deletions source/connect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ instance of MongoDB:

client = mongoc_client_new ("mongodb://localhost:27017");

To learn more about connecting to local deployments, see :ref:`c-connect-local`
in the Choose a Connection Target guide.

Atlas
~~~~~

Expand All @@ -81,6 +84,9 @@ deployment hosted on Atlas:

client = mongoc_client_new ("mongodb+srv://<db_username>:<db_password>@<hostname>/?<options>");

To learn more about connecting to Atlas, see :ref:`c-connect-atlas` in the
Choose a Connection Target guide.

Replica Set
~~~~~~~~~~~

Expand All @@ -91,15 +97,17 @@ replica set:

client = mongoc_client_new ("mongodb+srv://<replica-set-member>/?replicaSet=<replica_set_name>");

To learn more about connecting to replica sets, see
:ref:`c-connect-replica-sets` in the Choose a Connection Target guide.

Transport Layer Security (TLS)
------------------------------

The following sections describe how to connect to MongoDB
while enabling the TLS protocol.

.. TODO, uncomment once TLS page is merged
.. To learn more about using TLS with the {+driver-short+},
.. see :ref:`c-tls`.
To learn more about using TLS with the {+driver-short+},
see :ref:`c-tls`.

Enable TLS
~~~~~~~~~~
Expand All @@ -108,9 +116,8 @@ The following tabs demonstrate how to enable TLS on a connection:

.. include:: /includes/connect/tls-tabs.rst

.. TODO, uncomment once TLS page is merged
.. To learn more about enabling TLS, see :ref:`c-enable-tls` in
.. the TLS configuration guide.
To learn more about enabling TLS, see :ref:`c-enable-tls` in
the TLS configuration guide.

Disable Hostname Verification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -120,9 +127,9 @@ connecting by using TLS:

.. include:: /includes/connect/disable-host-verification-tabs.rst

.. TODO, uncomment once TLS page is merged
.. To learn more about disabling hostname verification, see :ref:`c-certificate-revocation` in
.. the TLS configuration guide.

To learn more about disabling hostname verification, see :ref:`c-certificate-revocation` in
the TLS configuration guide.

Network Compression
-------------------
Expand Down Expand Up @@ -185,5 +192,4 @@ The following code shows how to specify Stable API settings within a

mongoc_server_api_destroy (api);

.. TODO, uncomment once stable API page is merged
.. To learn more about the {+stable-api+}, see :ref:`c-stable-api`.
To learn more about the {+stable-api+}, see :ref:`c-stable-api`.
6 changes: 6 additions & 0 deletions source/connect/connection-targets.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Overview
In this guide, you can learn how to use a connection string and a ``mongoc_client_t`` object
to connect to different types of MongoDB deployments.

.. _c-connect-atlas:

Atlas
-----

Expand Down Expand Up @@ -55,6 +57,8 @@ code also uses the ``mongoc_server_api_new()`` function to specify a {+stable-ap
breaking changes when Atlas upgrades to a new version of {+mdb-server+}. To learn more
about the {+stable-api+}, see the :ref:`c-stable-api` guide.

.. _c-connect-local:

Local Deployments
-----------------

Expand All @@ -71,6 +75,8 @@ deployment:
:end-before: end-connect-local
:dedent:

.. _c-connect-replica-sets:

Replica Sets
------------

Expand Down
2 changes: 1 addition & 1 deletion source/connect/tls.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. c-tls:
.. _c-tls:

========================================
Configure Transport Layer Security (TLS)
Expand Down
Loading