Skip to content
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

CLOUDP-234797: Update docs about upgrades from replica sets to multi-… #2786

Merged
merged 5 commits into from
Mar 20, 2024

Conversation

blva
Copy link
Collaborator

@blva blva commented Mar 19, 2024

…sharded instances

Proposed changes

CLOUDP-234797

Checklist

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works
  • I have added any necessary documentation in document requirements section listed in CONTRIBUTING.md (if appropriate)
  • I have addressed the @mongodb/docs-cloud-team comments (if appropriate)
  • I have updated test/README.md (if an e2e test has been added)
  • I have run make fmt and formatted my code

Further comments

@blva blva marked this pull request as ready for review March 19, 2024 15:39
@blva blva requested a review from a team as a code owner March 19, 2024 15:39
@blva blva requested a review from a team March 19, 2024 15:39
gssbzn
gssbzn previously approved these changes Mar 19, 2024
zach-carr
zach-carr previously approved these changes Mar 20, 2024
Copy link
Contributor

@zach-carr zach-carr left a comment

Choose a reason for hiding this comment

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

Left some copy changes I recommend, other than those it LGTM. Happy to take another look if you want it

docs/command/atlas-clusters-update.txt Outdated Show resolved Hide resolved
@@ -18,6 +18,8 @@ You can specify modifications in a JSON configuration file with the --file flag.

You can't change the name of the cluster or downgrade the MongoDB version of your cluster.

You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy suggestions -- take a firm position that this isn't allowed (can not vs. must not), reorganize sentence structure a little bit to present more context to the user at the start of each one:

Suggested change
You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster.
To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

thanks! looks better

@@ -146,6 +146,8 @@ func UpdateBuilder() *cobra.Command {

You can't change the name of the cluster or downgrade the MongoDB version of your cluster.

You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment applies here if you change the other paragraph

Suggested change
You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster. To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster.

@blva blva dismissed stale reviews from zach-carr and gssbzn via 53ca9b4 March 20, 2024 13:33
@blva blva requested a review from zach-carr March 20, 2024 13:33
Copy link
Contributor

@zach-carr zach-carr left a comment

Choose a reason for hiding this comment

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

LGTM

@blva blva merged commit 4f0ebb9 into master Mar 20, 2024
17 checks passed
@blva blva deleted the CLOUDP-234797 branch March 20, 2024 13:51
@fmenezes fmenezes mentioned this pull request Apr 5, 2024
6 tasks
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.

3 participants