Skip to content

Docs fixes #3565

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
strickvl merged 9 commits into from
Apr 22, 2025
Merged

Docs fixes #3565

strickvl merged 9 commits into from
Apr 22, 2025

Conversation

@strickvl
Copy link
Contributor

@strickvl strickvl commented Apr 17, 2025

Fixes from the 'Remaining todos' Notion page.

strickvl and others added 6 commits April 17, 2025 21:39
@strickvl @claude
Remove duplicate runtime configuration section in docs
82a33f7 
Removed duplicated content about runtime configuration with `with_options` that appeared both in the beginning and at the end of the documentation. Preserved the unique information about PipelineRunConfiguration under a new heading.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@strickvl @claude
docs: clarify direct component assignment and ResourceSettings behavior
8fec996 
- Clarify that direct component assignment only works for experiment trackers and stack components
- Add note that ResourceSettings are not always applied by all orchestrators
- Fix DockerSettings link in containerization docs

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@strickvl @claude
docs: improve links and terminology in documentation
ca30240 
- Add link to ZenML stack in stack_components.md
- Correct term order to "Fan-out and Fan-in" for clarity
- Add link to Alerter component documentation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@strickvl
Fix formatting issues
8b46312
@strickvl
More docs fixes
441cd5f
@strickvl
Improve code repositories motivation
ad4a206
@strickvl strickvl added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Apr 17, 2025
@strickvl strickvl requested review from bcdurak, Copilot and htahir1 April 17, 2025 20:19
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 17, 2025

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

Copilot AI reviewed Apr 17, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 17, 2025 •
edited
Loading

✅ No broken links found!

@github-actions
Copy link
Contributor

github-actions bot commented Apr 17, 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-04-22 11:08:15 UTC

htahir1
htahir1 approved these changes Apr 21, 2025
View reviewed changes
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

I like it!

@strickvl
Copy link
Contributor Author

strickvl commented Apr 22, 2025

@htahir1 should I wait for Baris to review, and can I ignore the failing absolute links?

htahir1
htahir1 requested changes Apr 22, 2025
View reviewed changes
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Now i found something

@strickvl @htahir1
Update docs/book/how-to/steps-pipelines/configuration.md
94d687e 
Co-authored-by: Hamza Tahir <hamza@zenml.io>
@strickvl strickvl merged commit 9a276c2 into develop Apr 22, 2025
10 of 12 checks passed
@strickvl strickvl deleted the doc/alex-docs-fixes branch April 22, 2025 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@htahir1 htahir1 htahir1 approved these changes

@bcdurak bcdurak Awaiting requested review from bcdurak

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.

3 participants

@strickvl @htahir1