Skip to content

Conversation

@jromo-mdb
Copy link
Collaborator

@jromo-mdb jromo-mdb commented Oct 22, 2025

DOCSP-54845 include mongosync on latest auto upgrade disclaimers page

  • This PR fixes a note to warn users to not create clusters with auto upgrade configuration since some auto upgrades, such as 8.2, are incompatible with mongosync and Live Migration.
  • The rewording addresses adding mention of Mongosync Standalone and specifying Live Migration "in the Atlas UI". Also makes the emphasis neutral to both products, and focusing instead on the particular incompatibility when using dedicated clusters and auto upgrades.
  • Also this PR moves the include note from monorepo Atlas docs directory to "shared docs" repository, to fix a build error caused by including the file in the Mongosync directory of the docs monorepo.

Complement PR: This monorepo PR, updates the includes directives to the new path in the "shared-docs" repo and deletes the original include file in the atlas directory.
Related Jira Ticket: DOCSP-53318

Staging preview

  • No preview from monorepo until I merge this shared-docs include first.

@jromo-mdb jromo-mdb requested a review from JuliaMongo October 28, 2025 21:51
Copy link
Collaborator

@JuliaMongo JuliaMongo left a comment

Choose a reason for hiding this comment

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

LGTM, after comments.

Live Migration in the {+atlas-ui+} or standalone |mongosync|,
do NOT choose :guilabel:`Latest Version With Auto Upgrades`.
This option auto upgrades your {+cluster+} to the latest minor release.
Some minor releases, such as MongoDB version 8.2, may not be supported by Live
Copy link
Collaborator

Choose a reason for hiding this comment

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

may not support (instead of may not be supported)

do NOT choose :guilabel:`Latest Version With Auto Upgrades`.
This option auto upgrades your {+cluster+} to the latest minor release.
Some minor releases, such as MongoDB version 8.2, may not be supported by Live
Migration or Mongosync. Choose a major version instead to ensure compatibility
Copy link
Collaborator

@JuliaMongo JuliaMongo Oct 29, 2025

Choose a reason for hiding this comment

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

When upgrading, choose a major version to upgrade to instead. This ensures compatibility with Live Migration and mongosync.

JM: upgrade -- this could be a link. I am not sure this link will work in either product if we use a shared include. Please check. If not possible, don't use a link.

upgrade link: 
https://www.mongodb.com/docs/atlas/tutorial/major-version-change/#upgrade-your-major-mongodb-version

Also: Live Migration and mongosync are not products and we should not call them such.

Also, we had a note already and could have used the text from that note. That text was clear and reviewed, and I don't see a reason for rewriting that note here, if it was me, I'd just expand the existing note.

Lastly, I would name the note file: mongosync-dont-use-mdb-minor-version.rst
This makes it easier to future writers who will maintain this content to know instantly what's inside the note from its title. But up to you!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

All these are good suggestions. The link should work because of intersphinx. Will still merge the shared-docs PR first and then rerun the monorepo PR to verify logs for any errors. Thanks.

Copy link
Collaborator

@JuliaMongo JuliaMongo left a comment

Choose a reason for hiding this comment

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

LGTM with comments.

@jromo-mdb jromo-mdb merged commit a817089 into main Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants