DOCSP-51408-connection-troubleshooting #109
Conversation
✅ Deploy Preview for docs-kotlin-sync ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🔄 Deploy Preview for docs-kotlin-sync processing
|
source/connect/connection-pools.txt
Outdated
There was a problem hiding this comment.
S: I would add a .. TODO comment on the page just to keep things clear!
|
|
||
| .. replacement:: authentication-guide-reference | ||
|
|
||
| To learn more about specifying authentication mechanisms, see the :ref`kotlin-sync-auth` |
There was a problem hiding this comment.
| To learn more about specifying authentication mechanisms, see the :ref`kotlin-sync-auth` | |
| To learn more about specifying authentication mechanisms, see the :ref`<kotlin-sync-auth>` |
I: Broken ref, this should hopefully fix.
|
|
||
| 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:`kotlin-sync-connection-options` guide. |
There was a problem hiding this comment.
I: Make sure the Connection Options page is clickable as a landing page in the TOC.
| .. meta:: | ||
| :keywords: code example, disconnected, deployment | ||
|
|
||
| .. sharedinclude:: dbx/connection-troubleshooting.rst |
There was a problem hiding this comment.
S: The first line of the Server Connection Errors section reads, "When an issue occurs when you attempt to connect to a server, the Kotlin Sync driver returns an error message." I would make a PR to change the first word of this sentence to "if" ! Small change, but it would be nice to not include so much certainty that there will be an error.
There was a problem hiding this comment.
I'll send this PR out for tech review but make a new ticket/PR to reflect this work, as it's in a different repo!
shuangela
requested review from
a team and
katcharov
and removed request for
a team
| .. _kotlin-sync-connection-troubleshooting: | ||
|
|
||
| ========================== | ||
| Connection Troubleshooting |
There was a problem hiding this comment.
Note for reviewer: this page is almost identical to https://www.mongodb.com/docs/drivers/java/sync/current/connection/connection-troubleshooting/ except for two code examples that I've commented on below.
| corresponds to the authentication mechanism. The following code shows the builder | ||
| method for the ``SCRAM-SHA-256`` authentication mechanism: | ||
|
|
||
| .. code-block:: kotlin |
There was a problem hiding this comment.
This code is kotlin specific code that differs from the java sync version of this page.
|
|
||
| .. replacement:: authsource-param-code-block | ||
|
|
||
| .. code-block:: kotlin |
There was a problem hiding this comment.
This is Kotlin specific code that differs from the Java version of this page
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-51325
Staging Links
Self-Review Checklist