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
[DOCS] Reorganize Checkpoint Section #8182
Conversation
✅ Deploy Preview for niobium-lead-7998 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
@@ -1,27 +1,28 @@ | |||
--- | |||
title: Pass an in-memory DataFrame to a Checkpoint | |||
title: Validate Checkpoints with Expectations and data |
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.
I think it would be more accurate to say "Validate data with Expectations and Checkpoints." But the guide we would actually want in place of this one is: "Validate data and Expectations passed to a Checkpoint at runtime."
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.
I think we should make a note to rework this document fully. As it stands, the process can be applied to more than just in-memory data.
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.
@Rachel-Reverie I have updated the topic title as suggested. Who would be the SME that could help with the content rework? Do you prefer to take it on? If so, should we leave this PR open?
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.
I suggested a change to one of the guide titles. Technically, we use a Checkpoint to Validate data against Expectations; the Checkpoint is run, but not "validated." As a more general note, I think we should flag that doc for a full rework, since it is partially redundant to the others, and potentially lends itself to misleading conclusions about how to use Checkpoints with runtime parameters.
Otherwise, LGTM. Approving so I'm not blocking if the title update is implemented.
Description
Reorganized the Checkpoint section to meet the requirements specified in ticket DOC-553.
The following changes have been implemented:
The topic title Pass an in-memory DataFrame to a Checkpoint was updated to Validate Checkpoints with Expectations and data
Removed Run a Checkpoint to validate data from the TOC and relevant landing page
Moved Deploy a scheduled Checkpoint with cron below Manage Checkpoints and updated the relevant landing pages
Moved Use Data Docs URLs in custom Validation Actions below Configure Actions and updated the relevant landing pages
Definition of done