Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

DOCSP-48400-confusion-multi-shard-key #732

Merged

Conversation

shuangela
Copy link
Collaborator

@shuangela shuangela commented Apr 17, 2025

DESCRIPTION

Adds details on shard key in mongosync api example

STAGING

https://deploy-preview-732--docs-cluster-to-cluster-sync.netlify.app/reference/api/start/

JIRA

https://jira.mongodb.org/browse/DOCSP-48400

SELF-REVIEW CHECKLIST

  • Does each file have 3-5 taxonomy facet tags?
    See the taxonomy tagging instructions and this example PR
  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

EXTERNAL REVIEW REQUIREMENTS

What's expected of an external reviewer?

Copy link

netlify bot commented Apr 17, 2025

Deploy Preview for docs-cluster-to-cluster-sync ready!

Name Link
🔨 Latest commit fbb5335
🔍 Latest deploy log https://app.netlify.com/sites/docs-cluster-to-cluster-sync/deploys/680a4b3a6fe63b0008c47738
😎 Deploy Preview https://deploy-preview-732--docs-cluster-to-cluster-sync.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@jwilson-mdb jwilson-mdb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @shuangela LGTM - nice job keeping the style consistent with the other examples!

Comment on lines 368 to 369
The following example starts a sync job between the replica set ``cluster0`` and the
sharded cluster ``cluster1``. The source cluster is ``cluster0`` and the destination
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two first sentences here can be condensed

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well I see that's the case everywhere else. I'll leave it up to you about if we should change it, but it seems like it should be condensed throughout the page into one sentence

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good callout! I agree, I'll go in and condense all the descriptions to ensure consistency

Comment on lines 368 to 369
The following example starts a sync job between the replica set ``cluster0`` and the
sharded cluster ``cluster1``. The source cluster is ``cluster0`` and the destination
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well I see that's the case everywhere else. I'll leave it up to you about if we should change it, but it seems like it should be condensed throughout the page into one sentence

@@ -366,8 +366,8 @@ Start Sync from Replica Set to Sharded Cluster
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following example starts a sync job between the replica set ``cluster0`` and the
sharded cluster ``cluster1``. The source cluster is ``cluster0`` and the destination
cluster is ``cluster1``. The ``key`` array in this example defines the shard key ``{"location": 1, "region": 1 }``.
sharded cluster ``cluster1``. The ``key`` array in this example defines the shard key
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should still say that cluster0 is the source and 1 is the destination

@shuangela shuangela requested a review from rohshar April 24, 2025 14:40
@shuangela shuangela merged commit 9734cd3 into mongodb:master Apr 29, 2025
4 checks passed
shuangela added a commit to shuangela/docs-cluster-to-cluster-sync that referenced this pull request Apr 29, 2025
* add explaination

* condense wording

* add source and destination

(cherry picked from commit 9734cd3)
shuangela added a commit to shuangela/docs-cluster-to-cluster-sync that referenced this pull request Apr 29, 2025
* add explaination

* condense wording

* add source and destination

(cherry picked from commit 9734cd3)
shuangela added a commit to shuangela/docs-cluster-to-cluster-sync that referenced this pull request Apr 29, 2025
* add explaination

* condense wording

* add source and destination

(cherry picked from commit 9734cd3)
@shuangela
Copy link
Collaborator Author

💚 All backports created successfully

Status Branch Result
v1.13
v1.12
v1.11

Questions ?

Please refer to the Backport tool documentation

shuangela added a commit that referenced this pull request Apr 29, 2025
* add explaination

* condense wording

* add source and destination

(cherry picked from commit 9734cd3)
shuangela added a commit that referenced this pull request Apr 29, 2025
* add explaination

* condense wording

* add source and destination

(cherry picked from commit 9734cd3)
shuangela added a commit that referenced this pull request Apr 29, 2025
* add explaination

* condense wording

* add source and destination

(cherry picked from commit 9734cd3)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants