Fix tutorials + small improvements to docs #3489

htahir1 · 2025-04-01T17:23:26Z

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)

coderabbitai · 2025-04-01T17:23:34Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-04-01T17:24:46Z

Documentation Link Check Results

✅ Absolute links check passed
✅ Relative links check passed
_{Last checked: 2025-04-07 14:24:08 UTC}

strickvl · 2025-04-01T17:25:56Z

docs/book/user-guide/tutorials/managing-scheduled-pipelines.md

+The orchestrator then takes over responsibility for executing the pipeline\
 according to the schedule.


Suggested change

The orchestrator then takes over responsibility for executing the pipeline\

according to the schedule.

The orchestrator then takes over responsibility for executing the pipeline according to the schedule.

strickvl · 2025-04-01T17:26:05Z

docs/book/user-guide/tutorials/managing-scheduled-pipelines.md

+Running the pipeline will create the schedule in the ZenML metadata store. as\
 well as the scheduled run in the orchestrator.


Suggested change

Running the pipeline will create the schedule in the ZenML metadata store. as\

well as the scheduled run in the orchestrator.

Running the pipeline will create the schedule in the ZenML metadata store. as well as the scheduled run in the orchestrator.

strickvl · 2025-04-01T17:26:31Z

docs/book/user-guide/tutorials/organizing-pipelines-and-models.md

+2. **Projects** (ZenML Pro): Namespace-based isolation for logical separation\
   between initiatives or teams


Suggested change

2. **Projects** (ZenML Pro): Namespace-based isolation for logical separation\

between initiatives or teams

2. **Projects** (ZenML Pro): Namespace-based isolation for logical separation between initiatives or teams

strickvl · 2025-04-01T17:29:07Z

docs/book/user-guide/tutorials/managing-scheduled-pipelines.md

@@ -137,7 +139,7 @@ zenml pipeline schedule list --pipeline_id my_pipeline_id

 Here's an example of what the CLI output might look like:

-![Output of `zenml pipeline schedule list`](../../.gitbook/assets/pipeline-schedules-list.png)
+![Output of zenml pipeline schedule list](../../.gitbook/assets/pipeline-schedules-list.png)


Suggested change

![Output of zenml pipeline schedule list](../../.gitbook/assets/pipeline-schedules-list.png)

![Output of zenml pipeline schedule list](../.gitbook/assets/pipeline-schedules-list.png)

And could you move the png file from the root assets folder to the assets folder in the user-guide subfolder? I messed that up, but I doubt that's what's causing the issues.

github-actions · 2025-04-01T17:29:33Z

✅ No broken markdown links found!

…l links

…pdate, and delete schedules

…embeddings evaluation.- Add schedules list CLI image.- Verify schedule in Orchestrator

* GITBOOK-6: No subject * Update tutorial descriptions for managing and organizing pipelines * GITBOOK-7: No subject * GITBOOK-8: No subject * Delete tutorials README and update table of contents with new tutorial links * Add tutorial on managing scheduled pipelines.Explain how to create, update, and delete schedules * Update pipeline tutorial filenames for consistency * Update tutorial link to "Scheduled pipelines". * Update user guide TOC with tutorial heading correction * Update scheduled pipelines tutorial and managing pipelines * Update tutorial link to include full title * Update pipeline management link to tutorials subdirectory * Update link for managing scheduled pipelines in user guide * Update TOC.md to change "Tutorial" to "Tutorials". * Update tutorial header to singular form * GITBOOK-10: No subject * GITBOOK-11: No subject * Update tutorial links to 'tutorial' folder * Update visualization and add CLI output images.- Visualize finetuned embeddings evaluation.- Add schedules list CLI image.- Verify schedule in Orchestrator * Update Argilla integration link in finetuning guide * Set up CI/CD for ZenML pipelines in production * Update links in remote-storage.md for better readability * Update images and remove unnecessary figures in user guide * Update tutorials link and add new section in README (cherry picked from commit f422c0f)

GITBOOK-6: No subject

9851a3c

htahir1 requested a review from strickvl April 1, 2025 17:23

github-actions bot added the internal To filter out internal PRs and issues label Apr 1, 2025

strickvl approved these changes Apr 1, 2025

View reviewed changes

Update tutorial descriptions for managing and organizing pipelines

214e87b

strickvl requested changes Apr 1, 2025

View reviewed changes

htahir1 added 2 commits April 1, 2025 17:27

GITBOOK-7: No subject

3e1d8dc

GITBOOK-8: No subject

47529d5

strickvl reviewed Apr 1, 2025

View reviewed changes

htahir1 and others added 16 commits April 2, 2025 13:29

Delete tutorials README and update table of contents with new tutoria…

a58dde4

…l links

Add tutorial on managing scheduled pipelines.Explain how to create, u…

9b68009

…pdate, and delete schedules

Merge remote-tracking branch 'origin/develop' into doc/fixtoc2

11c0157

Merge remote-tracking branch 'origin/develop' into doc/fixtoc2

355c6cf

Update pipeline tutorial filenames for consistency

ab71df7

Update tutorial link to "Scheduled pipelines".

b7f2aa7

Update user guide TOC with tutorial heading correction

cd51f12

Update scheduled pipelines tutorial and managing pipelines

f67cdec

Update tutorial link to include full title

c52f256

Update pipeline management link to tutorials subdirectory

5788855

Update link for managing scheduled pipelines in user guide

d673cdb

Update TOC.md to change "Tutorial" to "Tutorials".

0c45bdd

Update tutorial header to singular form

cc4613a

GITBOOK-10: No subject

c16c0eb

GITBOOK-11: No subject

dd06130

Update tutorial links to 'tutorial' folder

9ecf7fe

htahir1 requested a review from strickvl April 7, 2025 14:12

strickvl approved these changes Apr 7, 2025

View reviewed changes

strickvl changed the title ~~TOC~~ Fix tutorials + small improvements to docs Apr 7, 2025

strickvl added the documentation Improvements or additions to documentation label Apr 7, 2025

htahir1 added 6 commits April 7, 2025 16:18

Update visualization and add CLI output images.- Visualize finetuned …

65329a8

…embeddings evaluation.- Add schedules list CLI image.- Verify schedule in Orchestrator

Update Argilla integration link in finetuning guide

897a397

Set up CI/CD for ZenML pipelines in production

c3e6d32

Update links in remote-storage.md for better readability

8808426

Update images and remove unnecessary figures in user guide

24ac3d3

Update tutorials link and add new section in README

6ee5c24

htahir1 merged commit f422c0f into develop Apr 7, 2025
14 checks passed

htahir1 deleted the doc/fixtoc2 branch April 7, 2025 14:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix tutorials + small improvements to docs #3489

Fix tutorials + small improvements to docs #3489

Uh oh!

htahir1 commented Apr 1, 2025

Uh oh!

coderabbitai bot commented Apr 1, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Apr 1, 2025 •

edited

Loading

Uh oh!

strickvl Apr 1, 2025

Uh oh!

strickvl Apr 1, 2025

Uh oh!

strickvl Apr 1, 2025

Uh oh!

strickvl Apr 1, 2025

Uh oh!

github-actions bot commented Apr 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

		The orchestrator then takes over responsibility for executing the pipeline\
		according to the schedule.

		Running the pipeline will create the schedule in the ZenML metadata store. as\
		well as the scheduled run in the orchestrator.

		2. Projects (ZenML Pro): Namespace-based isolation for logical separation\
		between initiatives or teams

	![Output of zenml pipeline schedule list](../../.gitbook/assets/pipeline-schedules-list.png)
	![Output of zenml pipeline schedule list](../.gitbook/assets/pipeline-schedules-list.png)

Fix tutorials + small improvements to docs #3489

Fix tutorials + small improvements to docs #3489

Uh oh!

Conversation

htahir1 commented Apr 1, 2025

Describe changes

Pre-requisites

Types of changes

Uh oh!

coderabbitai bot commented Apr 1, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

strickvl Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

strickvl Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

strickvl Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

strickvl Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 1, 2025 •

edited

Loading

github-actions bot commented Apr 1, 2025 •

edited

Loading