DOCSP-41105 new About mongosync page #345
Draft
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
ltran-mdb2
reviewed
Jul 15, 2024
ltran-mdb2
reviewed
Jul 15, 2024
There was a problem hiding this comment.
This is on a great track! I just left a few additional suggestions/questions. Feel free to reach out if you want to discuss anything! Thanks @sonderdonk-mdb !
Comment on lines
+100
to
+101
| indexes and resolves document conflicts. If write blocking is enabled, | ||
| ``mongosync`` turns write operations back on. |
There was a problem hiding this comment.
[suggestion] let's use active voice here
Suggested change
| indexes and resolves document conflicts. If write blocking is enabled, | |
| ``mongosync`` turns write operations back on. | |
| indexes and resolves document conflicts. If you enable write blocking, | |
| ``mongosync`` turns write operations back on. |
There was a problem hiding this comment.
I struggled with this because in most situations it is mongosync that enables write blocking, not the user (above I write "mongosync halts any writes on the
source cluster"). What do you think about saying, "If write blocking is true"?
* DOCS-41102 * DOCSP-41102 added to quickstart * DOCSP-41102
* DOCSP-40138-Mongosync-Delay-After-Resume-Restart * add 1.8 to toc * * * * * JA feedback * add retry bit
6 tasks
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.
DESCRIPTION
Created an "About mongosync" page that details the C2C process from start to finish
I also added a sentence linking the "about mongosync" page on the index page and added a small note to the "mongosync states" page.
Note for reviewers: I have been debating the name for this page. I went with "About mongosync" but "How mongosync Works" has been suggested.
STAGING
About mongosync: https://preview-mongodbsonderdonkmdb.gatsbyjs.io/cluster-sync/DOCSP-41105/reference/about-mongosync/
Index page: https://preview-mongodbsonderdonkmdb.gatsbyjs.io/cluster-sync/DOCSP-41105/
mongosync States: https://preview-mongodbsonderdonkmdb.gatsbyjs.io/cluster-sync/DOCSP-41105/reference/mongosync-states/
JIRA
https://jira.mongodb.org/browse/DOCSP-41105
BUILD LOG
https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=66959072fb8bd13b842ae240
SELF-REVIEW CHECKLIST
See the taxonomy tagging instructions and this example PR
EXTERNAL REVIEW REQUIREMENTS
What's expected of an external reviewer?