[Java Sync] Connection Section Reorg#648
Conversation
✅ Deploy Preview for docs-java ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
norareidy
left a comment
There was a problem hiding this comment.
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?
| AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/> | ||
|
|
||
| .. contents:: On this page | ||
| :local: |
There was a problem hiding this comment.
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: | |||
|
|
|||
There was a problem hiding this comment.
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/>` |
There was a problem hiding this comment.
I: link is broken, this should fix:
| - :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>` No newline at end of file |
There was a problem hiding this comment.
I: broken link
| - :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 |
There was a problem hiding this comment.
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:
| section <java-security>`, which includes :ref:`TLS/SSL <tls-ssl>` and :ref:`SOCKS5 Proxy | |
| section <java-security>`. |
2118a75 to
680da1e
Compare
norareidy
left a comment
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
S: I'd use a full sentence here
| section <java-security>`, which includes: | |
| section <java-security>`, which includes the following guides: |
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47274
Staging Links
Self-Review Checklist