Skip to content

[Java Sync] Connection Section Reorg #648

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.

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 12 commits into from
Mar 12, 2025

Conversation

rachel-mack
Copy link
Contributor

@rachel-mack rachel-mack commented Mar 3, 2025

Copy link

netlify bot commented Mar 3, 2025

Deploy Preview for docs-java ready!

Name Link
🔨 Latest commit a2775cd
🔍 Latest deploy log https://app.netlify.com/sites/docs-java/deploys/67d1cd5981e5eb0008b3a0ed
😎 Deploy Preview https://deploy-preview-648--docs-java.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rachel-mack rachel-mack marked this pull request as ready for review March 4, 2025 20:43
Copy link
Contributor

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

I added a few comments, and I also have a question about Connection Troubleshooting: the ticket for this PR mentions moving the troubleshooting info to other pages as applicable. Do you plan to just keep Connection Troubleshooting as a separate page and leave as is?

Connection Troubleshooting </connection/connection-troubleshooting>
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>

.. contents:: On this page
:local:
Copy link
Contributor

Choose a reason for hiding this comment

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

S: Can't comment on the lines directly, but I think the bullet list of pages needs to be updated: it can just include Create a MongoClient, Specify Connection Options, and Connection Troubleshooting

@@ -1,8 +1,8 @@
.. _java-connect-to-mongodb:

Copy link
Contributor

Choose a reason for hiding this comment

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

S: should we change the file name to reflect the new title (mongoclient.txt), and add another ref anchor (like .. _java-create-client)? I don't think these are necessary changes but it would help make things less confusing for writers

- :ref:`Stable API <stable-api-java>`
- :ref:`Network Compression <network-compression>`
- :ref:`JNDI Datasource <jndi>`
- :ref:`AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>`
Copy link
Contributor

Choose a reason for hiding this comment

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

I: link is broken, this should fix:

Suggested change
- :ref:`AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>`
- `AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>`__

- :ref:`Network Compression <network-compression>`
- :ref:`JNDI Datasource <jndi>`
- :ref:`AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>`
- :ref:`Connection Security Options <security-connection-options>`
Copy link
Contributor

Choose a reason for hiding this comment

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

I: broken link

Suggested change
- :ref:`Connection Security Options <security-connection-options>`
- :ref:`Connection Security Settings <security-connection-settings>`


MongoDB supports many options for securing your data before and during
transportation. For information about security options, see our :ref:`Security
section <java-security>`, which includes :ref:`TLS/SSL <tls-ssl>` and :ref:`SOCKS5 Proxy
Copy link
Contributor

Choose a reason for hiding this comment

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

S: the section also includes authentication (SCRAM, X.509, etc) options; you can also list those here, or just remove the list and keep it as:

Suggested change
section <java-security>`, which includes :ref:`TLS/SSL <tls-ssl>` and :ref:`SOCKS5 Proxy
section <java-security>`.

@rachel-mack rachel-mack requested a review from norareidy March 11, 2025 18:46
Copy link
Contributor

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

LGTM + small suggestion!


MongoDB supports many options for securing your data before and during
transportation. For information about security options, see our :ref:`Security
section <java-security>`, which includes:
Copy link
Contributor

Choose a reason for hiding this comment

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

S: I'd use a full sentence here

Suggested change
section <java-security>`, which includes:
section <java-security>`, which includes the following guides:

@rachel-mack rachel-mack merged commit 6cf68b6 into mongodb:master Mar 12, 2025
5 checks passed
@rachel-mack rachel-mack deleted the DOCSP-47274 branch March 12, 2025 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants