feat(workshop): update file workshop#198
Merged
PVinaches merged 1 commit intoKaotoIO:mainfrom Mar 9, 2026
Merged
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds a new blog post and a revised beginner workshop "Listen to a Folder" teaching directory event monitoring (CREATE/MODIFY/DELETE), message filtering, automatic backups, and local testing with Kaoto + Apache Camel. Documentation-only changes; no code or public API modifications. (≤50 words) Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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. Comment |
PVinaches
force-pushed
the
update-file-workshop
branch
2 times, most recently
from
d4de9f8 to
e3ebfb4
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/workshop/beginner-file/index.md`:
- Around line 65-68: Remove leading "$" from shell command examples and add
explicit code block language tags; e.g., change "`$ mkdir
file-monitor-workshop`" / "`$ cd file-monitor-workshop`" to plain lines "mkdir
file-monitor-workshop" and "cd file-monitor-workshop" inside a ```bash fenced
block, and add language tags for plain text/diagram blocks such as "File System
Events → File Watch → Filter (CREATE only) → Copy to Backup" by wrapping them in
```text (or ```bash for terminal snippets) so all offending blocks (the mkdir/cd
blocks, other terminal examples, and the diagram/terminal output blocks) use
correct language fences and drop the dollar prompt per MD014 and MD040.
- Line 429: The Markdown link "[Apache Camel YAML DSL]" points to the 4.0.x
docs; update the URL to point to the current Camel version (4.16.0) or to the
version-agnostic/generic docs path so readers see the correct reference; locate
the link text "[Apache Camel YAML DSL]" in the content and replace the href
"https://camel.apache.org/components/4.0.x/others/yaml-dsl.html" with the
appropriate URL for 4.16.0 or a stable/generic path.
- Around line 312-315: The example terminal output shows a route ID of
"route-2056" which doesn't match the YAML examples that use "route-2573"; update
the terminal snippet or the YAML so both use the same route ID (e.g., replace
"route-2056" with "route-2573" in the INFO line), or alternatively add a short
clarifying sentence near the snippet stating that route IDs (like
route-2573/route-2056) are auto-generated and will differ between runs; ensure
you update the example line containing "INFO [route-2056]" and/or the YAML
examples referencing "route-2573" to keep them consistent.
- Around line 37-39: Update the prerequisites bullet for "Apache Camel JBang" to
mark it as required (not "Optional but recommended") and add a short note that
Camel JBang is required for Part 3 because the Kaoto extension uses it to run
routes locally; preserve the existing installation commands (`curl -Ls ...` and
`jbang app install camel@apache/camel`) so readers can install it before
proceeding to Part 3's "play the route" step.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
content/blog/file-monitoring-workshop/featured.pngis excluded by!**/*.pngcontent/workshop/beginner-file/featured.pngis excluded by!**/*.png
📒 Files selected for processing (17)
content/blog/file-monitoring-workshop/index.mdcontent/workshop/beginner-file/file-watch-form.webpcontent/workshop/beginner-file/filter-form.webpcontent/workshop/beginner-file/filter-placeholder.webpcontent/workshop/beginner-file/hover-arrow.webpcontent/workshop/beginner-file/index.mdcontent/workshop/beginner-file/kaoto-ext-start.webpcontent/workshop/beginner-file/kaoto-vscode.webpcontent/workshop/beginner-file/new-route.webpcontent/workshop/beginner-file/partial-route.webpcontent/workshop/beginner-file/partial-route2.webpcontent/workshop/beginner-file/play-route.webpcontent/workshop/beginner-file/play-route2.webpcontent/workshop/beginner-file/replace-timer.webpcontent/workshop/beginner-file/search-file-watch.webpcontent/workshop/beginner-file/source-code-icon.webpcontent/workshop/beginner-file/top-panel.webp
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (5)
content/workshop/beginner-file/index.md (5)
37-39: JBang description still doesn't convey it's required for Part 3.The label was updated from "Optional but recommended" to "For easy infrastructure setup," but Part 3 Step 1 explicitly depends on Camel JBang (Line 309: "Watch the terminal output as Camel JBang starts the route," Line 317: "The Kaoto extension uses Camel JBang to run your route locally"). Readers who skip installation will hit a hard blocker in Part 3 with no prior warning.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 37 - 39, The Apache Camel JBang entry currently reads "For easy infrastructure setup" but is actually required for Part 3; update the description for the "Apache Camel JBang" item to clearly state it is required for Part 3 (e.g., "Required for Part 3 — used to run routes locally") and add a short note pointing readers to the Part 3 steps that depend on it (references: the "Apache Camel JBang" bulleted item and the Part 3 steps that mention "Camel JBang starts the route" / "Kaoto extension uses Camel JBang to run your route locally"); keep the existing install commands but ensure the label and a brief prerequisite warning appear earlier so readers won’t skip installation.
65-68: MD014: Remove$prefixes from bash commands (unresolved from previous review).Also applies to: 72-75
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 65 - 68, The bash code blocks at the shown snippets include shell prompt prefixes ("$ mkdir file-monitor-workshop", "$ cd file-monitor-workshop" and the later block at lines 72-75); remove the leading "$ " from each command so the code fences contain only the raw commands (e.g., "mkdir file-monitor-workshop" and "cd file-monitor-workshop") to comply with MD014 and the project's style; update all affected fenced code blocks accordingly.
327-328: MD014: Remaining$-prefixed commands in Part 3 (unresolved from previous review).Also applies to: 334-336, 341-343
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 327 - 328, Remove the literal shell prompt from the example commands so they comply with MD014: replace lines that start with "$ " (for example the line containing "$ echo \"test content\" > /tmp/tutorial/test1.txt" and the other $-prefixed commands later in the file) with the bare commands inside the fenced code blocks (e.g., "echo \"test content\" > /tmp/tutorial/test1.txt"), ensuring the fenced code blocks remain triple-backticked and the commands are directly runnable without the leading "$".
86-90: MD040: Fenced code block missing language tag (unresolved from previous review).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 86 - 90, The fenced code block containing the diagram (the block starting with ``` and showing "File System Events → File Watch → Filter (CREATE only) → Copy to Backup ... Log All Events") is missing a language tag and triggers MD040; add an appropriate language tag such as text (e.g., ```text) or mermaid/graphviz if you intend diagram rendering, so the fenced block becomes ```text (or the chosen language) to resolve the MD040 warning.
313-315: MD040: Terminal output block still missing a language tag.The past review flagged this — the route ID mismatch was resolved, but the fenced block at Line 313 still has no language specifier.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 313 - 315, The fenced code block containing "INFO [route-2573] Apache Camel 4.16.0 (file-monitor) started in ..." is missing a language tag (MD040); edit the fenced block (the triple-backticks around that terminal output) and add an appropriate language identifier such as text or console (e.g., change ``` to ```text or ```console) so the block is properly tagged; ensure you update the specific fenced block in content/workshop/beginner-file/index.md that contains that INFO line.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/workshop/beginner-file/index.md`:
- Around line 158-160: Update Part 1 Step 3 to explicitly instruct the reader to
add the Log processor after deleting SetBody: after removing the SetBody
component, click the route's add-processor (plus) button, search for and select
the "Log" processor (or drag the "Log" component into the route), place it where
SetBody was, then click the Log processor to open its properties; reference the
component names "SetBody" and "Log processor" so users know exactly what to add
and open.
- Around line 73-75: The setup uses Unix-style mkdir commands (the lines that
run "mkdir -p /tmp/tutorial" and "mkdir -p /tmp/backup") which will fail on
Windows; update the tutorial markdown to provide Windows alternatives or a WSL
prerequisite: add a short note below those commands explaining Windows
equivalents (PowerShell or CMD folder creation commands and an example using
%TEMP% or %USERPROFILE% or instruct users to use WSL), and mirror that guidance
for all other occurrences of the same commands elsewhere in the document.
---
Duplicate comments:
In `@content/workshop/beginner-file/index.md`:
- Around line 37-39: The Apache Camel JBang entry currently reads "For easy
infrastructure setup" but is actually required for Part 3; update the
description for the "Apache Camel JBang" item to clearly state it is required
for Part 3 (e.g., "Required for Part 3 — used to run routes locally") and add a
short note pointing readers to the Part 3 steps that depend on it (references:
the "Apache Camel JBang" bulleted item and the Part 3 steps that mention "Camel
JBang starts the route" / "Kaoto extension uses Camel JBang to run your route
locally"); keep the existing install commands but ensure the label and a brief
prerequisite warning appear earlier so readers won’t skip installation.
- Around line 65-68: The bash code blocks at the shown snippets include shell
prompt prefixes ("$ mkdir file-monitor-workshop", "$ cd file-monitor-workshop"
and the later block at lines 72-75); remove the leading "$ " from each command
so the code fences contain only the raw commands (e.g., "mkdir
file-monitor-workshop" and "cd file-monitor-workshop") to comply with MD014 and
the project's style; update all affected fenced code blocks accordingly.
- Around line 327-328: Remove the literal shell prompt from the example commands
so they comply with MD014: replace lines that start with "$ " (for example the
line containing "$ echo \"test content\" > /tmp/tutorial/test1.txt" and the
other $-prefixed commands later in the file) with the bare commands inside the
fenced code blocks (e.g., "echo \"test content\" > /tmp/tutorial/test1.txt"),
ensuring the fenced code blocks remain triple-backticked and the commands are
directly runnable without the leading "$".
- Around line 86-90: The fenced code block containing the diagram (the block
starting with ``` and showing "File System Events → File Watch → Filter (CREATE
only) → Copy to Backup ... Log All Events") is missing a language tag and
triggers MD040; add an appropriate language tag such as text (e.g., ```text) or
mermaid/graphviz if you intend diagram rendering, so the fenced block becomes
```text (or the chosen language) to resolve the MD040 warning.
- Around line 313-315: The fenced code block containing "INFO [route-2573]
Apache Camel 4.16.0 (file-monitor) started in ..." is missing a language tag
(MD040); edit the fenced block (the triple-backticks around that terminal
output) and add an appropriate language identifier such as text or console
(e.g., change ``` to ```text or ```console) so the block is properly tagged;
ensure you update the specific fenced block in
content/workshop/beginner-file/index.md that contains that INFO line.
igarashitm
previously approved these changes
Feb 25, 2026
Member
igarashitm
left a comment
igarashitm
left a comment
There was a problem hiding this comment.
Tried local build, both blog and workshop looks good, and by following the workshop route ran as expected.
PVinaches
force-pushed
the
update-file-workshop
branch
from
55b89e6 to
53760a4
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
content/workshop/beginner-file/index.md (1)
67-69:⚠️ Potential issue | 🟡 MinorThe Windows compatibility note is currently too broad.
The note says commands work in PowerShell/CMD, but later examples use Unix-style paths (
/tmp/...) andrm, which won’t work as-is in CMD/PowerShell. Please either scope guidance to Git Bash/WSL or provide Windows-native equivalents.🛠️ Suggested adjustment
-> **Windows users:** The commands shown work in PowerShell, Command Prompt, and Git Bash. If using Command Prompt, you may need to use `md` instead of `mkdir`. +> **Windows users:** Commands below assume Unix-style paths (`/tmp/...`) and tools like `rm`. +> Use **Git Bash/WSL**, or replace paths/commands with PowerShell equivalents.Also applies to: 320-336
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 67 - 69, The Windows compatibility note "[!NOTE] **Windows users:** ..." is too broad given later Unix-specific examples (`/tmp/...`, `rm`); either narrow the note to specify "Git Bash/WSL" only or add Windows-native equivalents for the commands and paths used later (e.g., PowerShell/CMD equivalents for `mkdir`, `rm`, and path formats). Update the same note and any later examples referenced (instances of `/tmp/...` and `rm`) so they include parallel Windows commands or a clear callout that examples assume a Unix-like shell.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/workshop/beginner-file/index.md`:
- Line 112: Update the sentence in index.md that reads “This tutorial was
created using this version and other versions have not being tested in this
context. If chosen other Camel versions, they may present slight variations in
component availability and presentation.” to correct the grammar: change “have
not being tested” to “have not been tested” and “If chosen other Camel versions”
to “If you choose other Camel versions,” keeping the rest of the sentence
unchanged.
- Line 108: Update the sentence "A new route will appear in the Kaoto visual
designer with a default timer component." to reflect the actual default
template: state that the new route includes a timer component plus pre-added
SetBody and Log processors (i.e., "A new route will appear in the Kaoto visual
designer with a default timer, a SetBody step, and a Log processor"). Edit the
line in index.md so later steps remain consistent with the pre-populated
components.
---
Duplicate comments:
In `@content/workshop/beginner-file/index.md`:
- Around line 67-69: The Windows compatibility note "[!NOTE] **Windows users:**
..." is too broad given later Unix-specific examples (`/tmp/...`, `rm`); either
narrow the note to specify "Git Bash/WSL" only or add Windows-native equivalents
for the commands and paths used later (e.g., PowerShell/CMD equivalents for
`mkdir`, `rm`, and path formats). Update the same note and any later examples
referenced (instances of `/tmp/...` and `rm`) so they include parallel Windows
commands or a clear callout that examples assume a Unix-like shell.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
content/blog/file-monitoring-workshop/featured.pngis excluded by!**/*.pngcontent/workshop/beginner-file/featured.pngis excluded by!**/*.png
📒 Files selected for processing (16)
content/blog/file-monitoring-workshop/index.mdcontent/workshop/beginner-file/file-watch-form.webpcontent/workshop/beginner-file/filter-form.webpcontent/workshop/beginner-file/filter-placeholder.webpcontent/workshop/beginner-file/hover-arrow.webpcontent/workshop/beginner-file/index.mdcontent/workshop/beginner-file/kaoto-ext-start.webpcontent/workshop/beginner-file/new-route.webpcontent/workshop/beginner-file/partial-route.webpcontent/workshop/beginner-file/partial-route2.webpcontent/workshop/beginner-file/play-route.webpcontent/workshop/beginner-file/play-route2.webpcontent/workshop/beginner-file/replace-timer.webpcontent/workshop/beginner-file/search-file-watch.webpcontent/workshop/beginner-file/source-code-icon.webpcontent/workshop/beginner-file/top-panel.webp
PVinaches
force-pushed
the
update-file-workshop
branch
from
53760a4 to
74246bd
Compare
djelinek
previously approved these changes
Mar 3, 2026
|
|
||
| ### Solution | ||
| ``` | ||
| INFO [route-2573] Apache Camel 4.16.0 (file-monitor) started in ... |
There was a problem hiding this comment.
No action need, just comment.
The state of running route can be also checked in Deployments view of Kaoto sidebar, the integration with green bullet near route should be listed once is running properly
lordrip
previously approved these changes
Mar 9, 2026
improved workshop test added new images added new blog post
PVinaches
dismissed stale reviews from lordrip, djelinek, and coderabbitai[bot]
via
9922616
PVinaches
force-pushed
the
update-file-workshop
branch
from
74246bd to
9922616
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
content/workshop/beginner-file/index.md (1)
111-111:⚠️ Potential issue | 🟡 MinorFix grammar: "If chosen other Camel versions" should be "If you choose other Camel versions."
The sentence fragment lacks a subject and proper verb form.
📝 Suggested fix
-6. Select **Camel Main 4.16.0** from the options that appear when clicking the Camel version selector. This tutorial was created using this version and other versions have not been tested in this context. If chosen other Camel versions, they may present slight variations in component availability and presentation. +6. Select **Camel Main 4.16.0** from the options that appear when clicking the Camel version selector. This tutorial was created using this version and other versions have not been tested in this context. If you choose other Camel versions, they may present slight variations in component availability and presentation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` at line 111, Fix the grammar in step 6's sentence about Camel versions: replace the fragment "If chosen other Camel versions, they may present slight variations..." with "If you choose other Camel versions, they may present slight variations..." so the sentence has a proper subject and verb; update the line that mentions "Camel Main 4.16.0" / step 6 in index.md.
🧹 Nitpick comments (1)
content/workshop/beginner-file/index.md (1)
67-68: Consider adding specific Windows path examples for clarity.The Windows note mentions adjusting file paths but doesn't show concrete examples. Since the workshop extensively uses
/tmp/tutorial/and/tmp/backup/throughout (Lines 134, 242, 319, 327, 334), Windows users may be unsure what paths to substitute.Consider either:
- Adding specific Windows path examples (e.g.,
C:\tmp\tutorial\or%TEMP%\tutorial\)- Recommending Git Bash for Unix-style path support
- Noting that the paths shown work in Git Bash but need conversion for Command Prompt/PowerShell
📝 Example enhancement
> [!NOTE] -> **Windows users:** This workshop was created in a Unix-based environment. While the commands shown should work in PowerShell, Command Prompt, and Git Bash, you may need to make adjustments accordingly. For example, if using Command Prompt, use `md` instead of `mkdir`, and adjust file paths to use Windows-style paths (e.g., `C:\tmp\tutorial\` instead of `/tmp/tutorial/`). +> **Windows users:** This workshop was created in a Unix-based environment. The `/tmp/` paths used throughout this workshop work directly in Git Bash but require conversion for Command Prompt or PowerShell. Use `C:\tmp\tutorial\` and `C:\tmp\backup\` instead of `/tmp/tutorial/` and `/tmp/backup/`. Alternatively, use Git Bash or WSL for native Unix-style path support.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/workshop/beginner-file/index.md` around lines 67 - 68, Update the [!NOTE] "Windows users" block to include concrete Windows path examples and a Git Bash recommendation: show substitutions for the Unix paths used in the doc (e.g., convert /tmp/tutorial/ and /tmp/backup/ to Windows examples like C:\tmp\tutorial\ and C:\tmp\backup\ and an environment-variable form like %TEMP%\tutorial\), explicitly state which shells accept Unix-style paths (Git Bash) and which require conversion (Command Prompt/PowerShell), and briefly mention the mkdir equivalents (md for cmd) so Windows readers can follow commands without guessing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@content/workshop/beginner-file/index.md`:
- Line 111: Fix the grammar in step 6's sentence about Camel versions: replace
the fragment "If chosen other Camel versions, they may present slight
variations..." with "If you choose other Camel versions, they may present slight
variations..." so the sentence has a proper subject and verb; update the line
that mentions "Camel Main 4.16.0" / step 6 in index.md.
---
Nitpick comments:
In `@content/workshop/beginner-file/index.md`:
- Around line 67-68: Update the [!NOTE] "Windows users" block to include
concrete Windows path examples and a Git Bash recommendation: show substitutions
for the Unix paths used in the doc (e.g., convert /tmp/tutorial/ and
/tmp/backup/ to Windows examples like C:\tmp\tutorial\ and C:\tmp\backup\ and an
environment-variable form like %TEMP%\tutorial\), explicitly state which shells
accept Unix-style paths (Git Bash) and which require conversion (Command
Prompt/PowerShell), and briefly mention the mkdir equivalents (md for cmd) so
Windows readers can follow commands without guessing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 627a87e5-92ac-4e6d-ac65-19bd5c26c218
⛔ Files ignored due to path filters (2)
content/blog/file-monitoring-workshop/featured.pngis excluded by!**/*.pngcontent/workshop/beginner-file/featured.pngis excluded by!**/*.png
📒 Files selected for processing (16)
content/blog/file-monitoring-workshop/index.mdcontent/workshop/beginner-file/file-watch-form.webpcontent/workshop/beginner-file/filter-form.webpcontent/workshop/beginner-file/filter-placeholder.webpcontent/workshop/beginner-file/hover-arrow.webpcontent/workshop/beginner-file/index.mdcontent/workshop/beginner-file/kaoto-ext-start.webpcontent/workshop/beginner-file/new-route.webpcontent/workshop/beginner-file/partial-route.webpcontent/workshop/beginner-file/partial-route2.webpcontent/workshop/beginner-file/play-route.webpcontent/workshop/beginner-file/play-route2.webpcontent/workshop/beginner-file/replace-timer.webpcontent/workshop/beginner-file/search-file-watch.webpcontent/workshop/beginner-file/source-code-icon.webpcontent/workshop/beginner-file/top-panel.webp
lordrip
approved these changes
Mar 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the existent beginner file workshop to the new format and adds a blog post about it.
fix: #197
Summary by CodeRabbit