zenml icon indicating copy to clipboard operation
zenml copied to clipboard

Much better Pro docs

Open AlexejPenner opened this issue 1 month ago β€’ 4 comments

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 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)

AlexejPenner avatar Nov 28 '25 10:11 AlexejPenner

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

github-actions[bot] avatar Nov 28 '25 10:11 github-actions[bot]

πŸ” 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

github-actions[bot] avatar Nov 28 '25 10:11 github-actions[bot]

https://zenml-io.gitbook.io/alexej/zenml-pro - view here to see it in action

AlexejPenner avatar Dec 03 '25 09:12 AlexejPenner

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.

github-actions[bot] avatar Dec 03 '25 14:12 github-actions[bot]

Check out this pull request onΒ  ReviewNB

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

github-actions[bot] avatar Dec 19 '25 07:12 github-actions[bot]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatedcrewai@​1.7.1 ⏡ 1.6.173100100100100
Updatedgoogle-adk@​1.21.0 ⏡ 1.14.193 +1100100100100
Addedopentelemetry-sdk@​1.38.099100100100100

View full report

socket-security[bot] avatar Dec 19 '25 07:12 socket-security[bot]

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.

github-actions[bot] avatar Dec 19 '25 13:12 github-actions[bot]

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.

github-actions[bot] avatar Dec 19 '25 13:12 github-actions[bot]