Add scarf checker script and CI workflow

[strickvl]

This pull request adds a scarf checker script and a CI workflow to the repository. The script checks for the presence of a scarf snippet in Markdown files and adds it if it's missing. This ensures consistency across the documentation.

Summary by CodeRabbit

• New Features

  • Implemented a "Scarf checker" workflow to ensure analytics tracking with Scarf is present in documentation.

• Documentation

  • Added tracking images and comments to various sections of the documentation for better analytics and user insights.

• Scripts

  • Introduced a script to automate the inclusion of tracking elements in documentation files.

[coderabbitai]

Important

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

Walkthrough

A new GitHub Actions workflow named "Scarf checker" has been introduced to ensure the presence of Scarf analytics in markdown documentation. The workflow triggers on certain events and runs a script to check and enforce the inclusion of a Scarf image link in the markdown files. Additionally, a Bash script has been added to validate this across documentation files, and updates have been made to various documents to include HTML comments and image tags for Scarf analytics.

Changes

Files	Change Summary
.github/workflows/scarf-check.yml	Added a GitHub Actions workflow to check for Scarf analytics in markdown files on certain events.
docs/book/.../user-management.md docs/book/.../how-do-i.md docs/book/.../custom-stack-solutions.md docs/book/.../minimal-gcp-stack.md docs/book/.../debug-and-solve-issues.md docs/book/.../handling-dependencies.md docs/book/.../environment-variables.md docs/book/.../pipelining-features.md	Added HTML comments and image tags for ZenML Scarf in various documentation files.
scripts/format.sh scripts/scarf-checker.sh	Introduced scripts to ensure the inclusion of Scarf image links in documentation files.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit's AI:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
  • @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[strickvl]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 487b4a9 and c7acd82.

Files selected for processing (11)

• .github/workflows/scarf-check.yml (1 hunks)
• docs/book/deploying-zenml/zenml-cloud/user-management.md (1 hunks)
• docs/book/reference/how-do-i.md (1 hunks)
• docs/book/stacks-and-components/custom-solutions/custom-stack-solutions.md (1 hunks)
• docs/book/stacks-and-components/stack-deployment/cloud-stacks/minimal-gcp-stack.md (1 hunks)
• docs/book/user-guide/advanced-guide/best-practices/debug-and-solve-issues.md (1 hunks)
• docs/book/user-guide/advanced-guide/best-practices/handling-dependencies.md (1 hunks)
• docs/book/user-guide/advanced-guide/environment-management/environment-variables.md (1 hunks)
• docs/book/user-guide/advanced-guide/pipelining-features/pipelining-features.md (1 hunks)
• scripts/format.sh (1 hunks)
• scripts/scarf-checker.sh (1 hunks)

Files skipped from review due to trivial changes (7)

• docs/book/deploying-zenml/zenml-cloud/user-management.md
• docs/book/stacks-and-components/custom-solutions/custom-stack-solutions.md
• docs/book/stacks-and-components/stack-deployment/cloud-stacks/minimal-gcp-stack.md
• docs/book/user-guide/advanced-guide/best-practices/debug-and-solve-issues.md
• docs/book/user-guide/advanced-guide/best-practices/handling-dependencies.md
• docs/book/user-guide/advanced-guide/environment-management/environment-variables.md
• docs/book/user-guide/advanced-guide/pipelining-features/pipelining-features.md

Additional comments: 8

.github/workflows/scarf-check.yml (2)

• 1-8: The workflow is correctly set up to trigger on workflow_dispatch and when Markdown files are changed in a pull request. This aligns with the PR objectives.

• 12-12: The condition to run only on non-draft PRs is appropriate to ensure the check is performed before merging. However, it's important to verify that this condition works as expected in the repository's CI environment.

scripts/scarf-checker.sh (3)

• 1-4: The shebang and search text are set correctly. The search text matches the snippet that needs to be present in the Markdown files.

• 9-16: The loop correctly finds all Markdown files in the docs/book directory, excluding toc.md, and checks for the presence of the scarf snippet. The logic is sound and aligns with the PR objectives.

• 18-23: The script exits with a non-zero status if any file is missing the snippet, which is the correct behavior for a CI check. The success message is clear and informative.

scripts/format.sh (2)

• 12-38: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-14]

The script starts with a shebang and sets flags for debugging and analytics opt-out. It then runs ruff for code formatting, which is unrelated to the scarf snippet addition. This part of the script is not directly related to the PR objectives but is part of the formatting process.

• 17-37: The script correctly searches for the specified text in Markdown files within docs/book, excluding toc.md, and appends the scarf snippet if it is missing. This aligns with the PR objectives and ensures consistency across documentation files.

docs/book/reference/how-do-i.md (1)

• 58-61: The HTML comment and image tag for the ZenML Scarf have been added correctly to the Markdown file. This change is consistent with the updates described in the PR objectives and ensures the presence of the tracking snippet.