-
Notifications
You must be signed in to change notification settings - Fork 49
(DOCSP-54845) Move include file from atlas to shared docs repo #138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
JuliaMongo
left a comment
There was a problem hiding this 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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.
JuliaMongo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with comments.
DOCSP-54845 include mongosync on latest auto upgrade disclaimers page
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