Cluvio: Usage guide

[amotl]

About

Continue adding integration guides from the community forum.

Preview

• https://cratedb-guide--284.org.readthedocs.build/integrate/cluvio/

References

• Consolidate Integration Guides I vs. II #102

Trivia

@coderabbitai: Please review and convert to active voice.

[coderabbitai]

Walkthrough

Adds a new Cluvio tutorial page and updates the Cluvio integration index to reference it via a hidden toctree and a cross-reference link, replacing a direct URL.

Changes

Cohort / File(s)	Summary of changes
Cluvio integration index updates docs/integrate/cluvio/index.md	Switched a grid item link from external URL to ref cluvio-tutorial; appended a hidden toctree with a single entry “Tutorial ”.
New Cluvio tutorial docs/integrate/cluvio/tutorial.md	Added a step-by-step tutorial covering prerequisites, CrateDB setup, CSV imports, sample SQL, Cluvio connection, dashboards/reports, filters, snippets, and links/resources with images.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Integrate/Telegraf: Add micro tutorial. Improve layout on index page. #267 — Similar pattern: adds a micro tutorial under docs/integrate/* and updates index to include toctree/ref-based Tutorial card.
• Naming things: {learn,usage}.md -> tutorial.md #250 — Performs the same navigation change: replacing URL entries with a “Tutorial ” cross-reference and adding the tutorial page/toctree entry.

Suggested labels

new content, cross linking

Suggested reviewers

• bmunkholm
• kneth

Poem

A nibble of docs, a hop through trees,
I stitched a trail with gentle ease—
From index burrow to tutorial glade,
With SQL seeds and dashboards made.
Thump, thump! I bound with merry cheer,
New paths to Cluvio now appear. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The pull request description clearly states the intent to add integration guides, includes a preview link and reference, and asks for a voice edit; these points directly relate to the changes (new Cluvio tutorial and index updates), so the description is on-topic and sufficient for this lenient check.
Title Check	✅ Passed	The title "Cluvio: Usage guide" concisely identifies the primary change — adding a Cluvio usage/tutorial — and directly relates to the new tutorial file and updated index. It is short, specific, and readable, so a teammate scanning PR history can grasp the main purpose. While slightly less action-oriented than "Add Cluvio starter tutorial," it accurately summarizes the changes.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cluvio

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}