Skip to content

Snapshot docs #4023

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Oct 2, 2025
Merged

Snapshot docs #4023

merged 11 commits into from
Oct 2, 2025

Conversation

schustmi
Copy link
Contributor

Describe changes

I implemented/fixed _ to achieve _.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • IMPORTANT: I made sure that my changes are reflected properly in the following resources:
    • ZenML Docs
    • Dashboard: Needs to be communicated to the frontend team.
    • Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
    • Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@github-actions github-actions bot added internal To filter out internal PRs and issues documentation Improvements or additions to documentation labels Sep 30, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 30, 2025 •
edited
Loading

Documentation Link Check Results

❌ Absolute links check failed
There are broken absolute links in the documentation. See workflow logs for details
✅ Relative links check passed
Last checked: 2025-10-02 13:24:15 UTC

@strickvl
Copy link
Contributor

Probably need to add the snapshot concept to the 'core concepts' page as well

strickvl
strickvl reviewed Sep 30, 2025
View reviewed changes
Copy link
Contributor

@strickvl strickvl left a comment

Choose a reason for hiding this comment

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

There's also a whole tutorial about run templates which also needs updating.

docs/book/how-to/snapshots/snapshots.md Outdated

This enables your team to standardize execution patterns while maintaining flexibility - perfect for production ML workflows that need to be triggered from various systems.

![Working with Snapshots](../../.gitbook/assets/run-templates.gif)
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe rename or duplicate the file? feels like someone might delete it at some point accidentally.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep I'll have to create new screenshots for all of these, and will remove the old ones

@schustmi schustmi requested a review from strickvl October 1, 2025 13:23
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 1, 2025

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 41.8%, saving 193.57 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/create-snapshot-1.png 192.83 KB 117.95 KB -38.8% View diff
docs/book/.gitbook/assets/create-snapshot-2.png 92.84 KB 52.81 KB -43.1% View diff
docs/book/.gitbook/assets/run-snapshot.png 137.14 KB 79.78 KB -41.8% View diff
docs/book/.gitbook/assets/snapshot-run-dag.png 40.31 KB 19.00 KB -52.9% View diff

392 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

strickvl
strickvl requested changes Oct 1, 2025
View reviewed changes
Copy link
Contributor

@strickvl strickvl left a comment

Choose a reason for hiding this comment

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

Just some nits.

Also, were the core concepts page changes in a different PR?

@schustmi @strickvl
Apply suggestions from code review
29ae97b 
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
@schustmi schustmi requested a review from strickvl October 1, 2025 13:54
@schustmi
Copy link
Contributor Author

schustmi commented Oct 1, 2025

Ah I forgot the core concept, I'll add it as well.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 1, 2025 •
edited
Loading

✅ No broken links found!

@schustmi schustmi merged commit 7ce5488 into develop Oct 2, 2025
20 of 22 checks passed
@schustmi schustmi deleted the docs/pipeline-snapshots branch October 2, 2025 13:26
schustmi added a commit that referenced this pull request Oct 2, 2025
@schustmi @strickvl @github-actions
Snapshot docs (#4023)
7c74eff 
* Snapshot docs

* Replace all mentions of run templates with snapshots

* Update docs/book/how-to/snapshots/snapshots.md

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* Some PR comment fixes

* Change pics

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* Core concept + code block fixes

* Better snapshot description

* Revert some links back to absolute

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit 7ce5488)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@strickvl strickvl strickvl approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation internal To filter out internal PRs and issues

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@schustmi @strickvl