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

Update documentation for InlineVerifier and TargetVerifier #181

Merged
merged 2 commits into from
May 5, 2020

Conversation

fjordan
Copy link
Contributor

@fjordan fjordan commented Apr 30, 2020

Follow up of the recent work done to add the TargetVerifier. Also includes updates for the InlineVerifier in the documentation.

The architecture diagram was modified to include the BinlogWriter, TargetVerifier, and InlineVerifier loops. The InlineVerification step was also added to the TableIterator loop to display where in the processes the data is now verified as the InlineVerifier is now used in place of the IterativeVerifier.

Updated the documentation the Verifiers with two new sections - one for the InlineVerifier and another for the TargetVerifier.

On what should reviewers focus?

Please read through the added written documentation and visual documentation to ensure they are both accurate and complete.

/cc @Shopify/pods

@fjordan fjordan requested review from shuhaowu and hkdsun April 30, 2020 22:29
Copy link
Contributor

@shuhaowu shuhaowu left a comment

Choose a reason for hiding this comment

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

Thanks so much!

@@ -39,7 +39,7 @@ are given below:

If you want verification, you should try with the ``ChecksumTableVerifier``
first if you're copying whole tables at a time. If that takes too long, you can
try using the ``IterativeVerifier``. Alternatively, you can verify in a staging
try using the ``IterativeVerifier`` or ``InlineVerifier``. Alternatively, you can verify in a staging
run and not verify during the production run (see :ref:`copydbinprod`).

IterativeVerifier
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add a line saying this is deprecated and will be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

Copy link
Contributor

@hkdsun hkdsun left a comment

Choose a reason for hiding this comment

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

Thanks!

@fjordan fjordan force-pushed the feature/update-docs-new-verifiers branch from 0fc647a to 66c3205 Compare May 5, 2020 15:45
@fjordan fjordan merged commit 04dda85 into master May 5, 2020
@fjordan fjordan deleted the feature/update-docs-new-verifiers branch May 5, 2020 15:47
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