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

fix: Enable, instead of Configure, conflict detection #6708

Merged

Conversation

richardmcclellan
Copy link
Contributor

Customers often struggle quite a bit to figure out how to enable/disable conflict detection with the CLI. They can do it via the top level "Enable DataStore for entire API" or "Disable DataStore for entire API" options, but if they choose to walk through all options, they are forced to explicit decide if conflict detection should be enabled or not. I've been confused by this myself. Initially I thought that the "Configure conflict detection?" step was just a question asking if I wanted to make a change to the current value. That's not the case. If you answer "y", it enables conflict detection. If you answer "n", it disables conflict detection. This PR changes the wording so that customers know that this is causing an action.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@richardmcclellan richardmcclellan requested a review from a team as a code owner February 23, 2021 00:05
@codecov
Copy link

codecov bot commented Feb 23, 2021

Codecov Report

Merging #6708 (4d02e61) into master (966726c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #6708   +/-   ##
=======================================
  Coverage   56.80%   56.80%           
=======================================
  Files         486      486           
  Lines       22030    22030           
  Branches     4400     4400           
=======================================
  Hits        12515    12515           
  Misses       8638     8638           
  Partials      877      877           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 966726c...4d02e61. Read the comment docs.

Copy link
Member

@palpatim palpatim left a comment

Choose a reason for hiding this comment

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

Approved, contingent upon verifying there aren't any scripts or ancillary processes that rely on this wording.

Do we need to make doc updates as well? I believe our DataStore docs have references to conflict detection in the CLI.

@richardmcclellan
Copy link
Contributor Author

Approved, contingent upon verifying there aren't any scripts or ancillary processes that rely on this wording.

Yes, it would be great if someone from the CLI team can confirm this change. I just did a simple find and replace, and am not familiar with the codebase at all.

Do we need to make doc updates as well? I believe our DataStore docs have references to conflict detection in the CLI.

Good call! Here's a PR to update the docs: aws-amplify/docs#2981

Copy link
Contributor

@jhockett jhockett left a comment

Choose a reason for hiding this comment

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

LGTM, @renebrandel confirmed that this changed was approved in an API review

@richardmcclellan
Copy link
Contributor Author

Thanks @jhockett! Please go ahead and merge this if you can, as I don't have write permissions to do so.

@edwardfoyle edwardfoyle merged commit dac6ae9 into aws-amplify:master Feb 26, 2021
@richardmcclellan richardmcclellan deleted the enable-conflict-detection branch February 26, 2021 23:36
@github-actions
Copy link

This pull request has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server *-help channels for those types of questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 27, 2022
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.

None yet

5 participants