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

[DOCS] Reorganize Checkpoint Section #8182

Merged
merged 6 commits into from Jun 26, 2023
Merged

Conversation

kwcanuck
Copy link
Contributor

@kwcanuck kwcanuck commented Jun 26, 2023

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

  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Appropriate tests and docs have been updated

@netlify
Copy link

netlify bot commented Jun 26, 2023

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit aef73ae
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/6499cbf698e5d7000812cdac
😎 Deploy Preview https://deploy-preview-8182--niobium-lead-7998.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added the devrel This item is being addressed by the Developer Relations Team label Jun 26, 2023
@ghost
Copy link

ghost commented Jun 26, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@@ -1,27 +1,28 @@
---
title: Pass an in-memory DataFrame to a Checkpoint
title: Validate Checkpoints with Expectations and data
Copy link
Contributor

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."

Copy link
Contributor

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.

Copy link
Contributor Author

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?

Copy link
Contributor

@Rachel-Reverie Rachel-Reverie left a 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.

@kwcanuck kwcanuck merged commit 108e28f into develop Jun 26, 2023
51 checks passed
@kwcanuck kwcanuck deleted the checkpoint_guides_reorg branch June 26, 2023 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devrel This item is being addressed by the Developer Relations Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants