DOCSP-32269 atlas top 250 revamp connection page #458
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jordan-smith721
requested changes
Sep 27, 2023
Comment on lines
64
to
65
| This format offers flexibility in deployment and the ability to change | ||
| the servers in rotation without reconfiguring clients. |
| the :manual:`Standard Connection String Format | ||
| </reference/connection-string/#std-label-connections-standard-connection-string-format>`. | ||
|
|
||
| After the protocol, the next part of the connection string contains |
There was a problem hiding this comment.
Suggestion: I think "after the protocol" and "the next part" mean the same thing. I think it could be simplified to:
Suggested change
| After the protocol, the next part of the connection string contains | |
| After the protocol, the connection string contains your |
| @@ -4,8 +4,9 @@ | |||
| Connect to MongoDB | |||
| ================== | |||
|
|
|||
| In this guide, you can learn how to connect to a MongoDB instance or | |||
| replica set using the Java driver. | |||
| This guide shows you how to connect to a | |||
There was a problem hiding this comment.
Nitpick/Suggestion: I think the phrase "This guide shows you" is personifying the page. It seems more clear to me to stick with the "you can learn" format. (This is probably pretty subjective so feel free to take or leave this comment)
Suggested change
| This guide shows you how to connect to a | |
| In this guide, you can learn how to connect to a |
| .. figure:: /includes/figures/connection_uri_parts.png | ||
| :alt: Connection String parts figure | ||
| .. figure:: /includes/figures/dns_seedlist_connection_string_parts.png | ||
| :alt: Each part of the connection string |
There was a problem hiding this comment.
We should use better alt text here for accessibility. It should be meaningful to someone who can't see this image. Something like:
Suggested change
| :alt: Each part of the connection string | |
| :alt: An example of a connection string that demonstrates the protocol, credentials, hostname or IP, port, and connection options |
| ``mongodb`` for the protocol. You can also use the :manual:`DNS Seed List Connection Format </reference/connection-string/#dns-seed-list-connection-format>`, | ||
| ``mongodb+srv``, if you want more flexibility of deployment and the ability | ||
| to change the servers in rotation without reconfiguring clients. | ||
| In this example, we connect to an Atlas MongoDB deployment that has a |
There was a problem hiding this comment.
Style: Write to the user by using second person. (ref)
Suggested change
| In this example, we connect to an Atlas MongoDB deployment that has a | |
| In this example, you connect to an Atlas MongoDB deployment that has a |
kyuan-mongodb
added a commit
to kyuan-mongodb/docs-java
that referenced
this pull request
Oct 6, 2023
) * revamped connection and compat page (cherry picked from commit ed4ba2f)
kyuan-mongodb
added a commit
to kyuan-mongodb/docs-java
that referenced
this pull request
Oct 6, 2023
) * revamped connection and compat page (cherry picked from commit ed4ba2f)
kyuan-mongodb
added a commit
to kyuan-mongodb/docs-java
that referenced
this pull request
Oct 6, 2023
) * revamped connection and compat page (cherry picked from commit ed4ba2f)
kyuan-mongodb
added a commit
to kyuan-mongodb/docs-java
that referenced
this pull request
Oct 6, 2023
) * revamped connection and compat page (cherry picked from commit ed4ba2f)
kyuan-mongodb
added a commit
to kyuan-mongodb/docs-java
that referenced
this pull request
Oct 6, 2023
) * revamped connection and compat page (cherry picked from commit ed4ba2f)
kyuan-mongodb
added a commit
to kyuan-mongodb/docs-java
that referenced
this pull request
Oct 6, 2023
) * revamped connection and compat page (cherry picked from commit ed4ba2f)
This was referenced Oct 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
Revamped the connection page -- similar to the Node.js driver updates here.
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-32269
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/java/docsworker-xlarge/DOCSP-32269/fundamentals/connection/connect/
Self-Review Checklist