Much better Pro docs
Describe changes
I added a section per deployment scenario - https://zenml-io.gitbook.io/alexej/zenml-pro
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
developand the open PR is targetingdevelop. 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)
Documentation Link Check Results
β Absolute links check failed There are broken absolute links in the documentation. See workflow logs for details β Relative links check failed There are broken relative links in the documentation. See workflow logs for details Last checked: 2025-12-19 13:45:49 UTC
π Broken Links Report
Summary
- π Files with broken links: 3
- π Total broken links: 3
- π Broken markdown links: 2
- πΌοΈ Broken image links: 1
- β οΈ Broken reference placeholders: 0
Details
| File | Link Type | Link Text | Broken Path |
|---|---|---|---|
zenml-pro/system-architecture.md |
πΌοΈ | "ZenML Pro High-Level Architecture Placeholder" | ../../.gitbook/.assets/Agnostic-diagram-placeholder.png |
zenml-pro/hybrid-deployment-helm.md |
π | "Set up users and teams" | ../organization.md |
zenml-pro/hybrid-deployment-ecs.md |
π | "Set up users and teams" | ../organization.md |
π Full file paths
-
/home/runner/work/zenml/zenml/scripts/../docs/book/getting-started/zenml-pro/system-architecture.md -
/home/runner/work/zenml/zenml/scripts/../docs/book/getting-started/zenml-pro/hybrid-deployment-helm.md -
/home/runner/work/zenml/zenml/scripts/../docs/book/getting-started/zenml-pro/hybrid-deployment-ecs.md
https://zenml-io.gitbook.io/alexej/zenml-pro - view here to see it in action
Images automagically compressed by Calibre's image-actions β¨
Compression reduced images by 34%, saving 132.21 KB.
| Filename | Before | After | Improvement | Visual comparison |
|---|---|---|---|---|
docs/book/getting-started/zenml-pro/.gitbook/assets/pro-workload-managers.png |
388.76 KB | 256.55 KB | -34.0% | View diff |
383 images did not require optimisation.
Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.
Check out this pull request onΒ ![]()
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
Changelog Validation Results
β
Changelog validation passed
The changelog.json file conforms to the required schema structure.
Last checked: 2025-12-19 13:45:08 UTC
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
| Diff | Package | Supply Chain Security |
Vulnerability | Quality | Maintenance | License |
|---|---|---|---|---|---|---|
| crewai@β1.7.1 β΅ 1.6.1 | ||||||
| google-adk@β1.21.0 β΅ 1.14.1 | ||||||
| opentelemetry-sdk@β1.38.0 |
Images automagically compressed by Calibre's image-actions β¨
Compression reduced images by 24%, saving 30.88 KB.
| Filename | Before | After | Improvement | Visual comparison |
|---|---|---|---|---|
docs/book/getting-started/zenml-pro/.gitbook/assets/Agnostic-diagram-placeholder.jpg |
128.41 KB | 97.53 KB | -24.0% | View diff |
412 images did not require optimisation.
Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.
Images automagically compressed by Calibre's image-actions β¨
Compression reduced images by 9.4%, saving 33.96 KB.
| Filename | Before | After | Improvement | Visual comparison |
|---|---|---|---|---|
docs/book/getting-started/zenml-pro/.gitbook/assets/Agnostic-diagram-placeholder.png |
359.48 KB | 325.52 KB | -9.4% | View diff |
413 images did not require optimisation.
Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.