DOCSP-48242-mongosync-metadata-post-sync #651
Conversation
✅ Deploy Preview for docs-cluster-to-cluster-sync ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks for these updates, @amalhotra-mdb! I've left a suggestion/question for your consideration.
Thanks!
Joe
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| ``mongosync`` stores its metadata in a database during migration. The metadata | ||
| database may be named any of the following: |
There was a problem hiding this comment.
[verb suggestion/question]
I think we should update this to use a different modal verb. Genereally, we use "may" in the docs to indicate permission: https://www.mongodb.com/docs/meta/style-guide/writing/use-effective-verbs/#use-modal-verbs-accurately
Would it make sense to update to "The metadata database will be named one of the following:"? I'm not sure if this is technically correct, though. Are we saying that it will be just one of these, or could there be multiple databases?
There was a problem hiding this comment.
Thank you for your review @jmd-mongo ! I confirmed with @FGasper that there can be multiple databases; for example, mongosync’s embedded verifier stores its metadata separately from the rest of mongosync. I updated the PR accordingly, LMK if the changes look ok to you!
There was a problem hiding this comment.
Thanks for the additional updates, @amalhotra-mdb! This one LGTM at this point.
Thanks,
Joe
* DOCSP-48242-mongosync-metadata-post-sync * capitalize heading * reviewer updates * clarification (cherry picked from commit 8d1329a)
* DOCSP-48242-mongosync-metadata-post-sync * capitalize heading * reviewer updates * clarification (cherry picked from commit 8d1329a)
* DOCSP-48242-mongosync-metadata-post-sync * capitalize heading * reviewer updates * clarification (cherry picked from commit 8d1329a)
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
* DOCSP-48242-mongosync-metadata-post-sync * capitalize heading * reviewer updates * clarification (cherry picked from commit 8d1329a)
DESCRIPTION
Add info to mongosync behavior page ab metadata databases created during migration.
STAGING
https://deploy-preview-651--docs-cluster-to-cluster-sync.netlify.app/reference/mongosync/mongosync-behavior/#mongosync-metadata
JIRA
https://jira.mongodb.org/browse/DOCSP-48242
BUILD LOG
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?