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

Conversation

@amalhotra-mdb
Copy link
Collaborator

@amalhotra-mdb amalhotra-mdb commented Oct 23, 2024

DESCRIPTION

  • the mongosync docs do mention that unique indexes on the source cluster that are part of sharded collections on the destination cluster must have the shard key as a prefix
    • but this info is only in the “Supporting Indexes” section!
    • this can be an issue if the user is looking at the "Sharding Parameters" table and misses this info – can cause a failure during the commit phase of mongosync, which can take a while to get to!

This PR adds a link to the "Supporting Indexes" section in the createSupportingIndexes description under the "Sharding Parameters" table to ensure users don't miss this key detail.

STAGING

https://deploy-preview-448--docs-cluster-to-cluster-sync.netlify.app/reference/api/start/#sharding-parameters

JIRA

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

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?

@netlify
Copy link

netlify bot commented Oct 23, 2024

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

Name Link
🔨 Latest commit 5f5b5bb
🔍 Latest deploy log https://app.netlify.com/sites/docs-cluster-to-cluster-sync/deploys/671915b7ba24c00008df6d1f
😎 Deploy Preview https://deploy-preview-448--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

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

Thanks for this update, @amalhotra-mdb! I've left a suggestion for your consideration.

Thanks,
Joe

- Optional. Sets whether sync creates a supporting index
for the shard key, if none exists. Defaults to ``false``.

For more information and current limitations, see
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion]

I think we can remove "current" here and retain the same meaning.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you for taking a look at this, @jmd-mongo ! BTY!

Copy link
Collaborator

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

LGTM!

Thanks,
Joe

Copy link

@janetio janetio left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

@mdb-ashley mdb-ashley merged commit 170a7fe into mongodb:master Oct 24, 2024
3 checks passed
amalhotra-mdb added a commit to amalhotra-mdb/docs-cluster-to-cluster-sync that referenced this pull request Oct 24, 2024
* DOCSP-44549-specify-supporting-index-behavior

* remove 'current'
sarah-olson-mongodb pushed a commit that referenced this pull request Oct 24, 2024
* DOCSP-44549-specify-supporting-index-behavior

* remove 'current'
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.

4 participants