Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 16, 2025

@amotl amotl added the cross linking Linking to different locations of the documentation. label Oct 16, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 16, 2025

Walkthrough

Adds a new Scala JDBC guide and driver card to the Connect drivers index, and extracts Java JDBC driver option text into a new include file referenced from the Java driver page.

Changes

Cohort / File(s) Summary
Scala driver docs
docs/connect/scala/index.md, docs/connect/index.md
Adds docs/connect/scala/index.md with build.sbt snippet, example.scala, CrateDB Cloud SSL notes and quickstart. Inserts a new Scala driver grid card and adds scala/index to the Drivers toctree in docs/connect/index.md.
Java driver options include
docs/connect/java/_driver_options.md, docs/connect/java/index.md
Creates docs/connect/java/_driver_options.md with guidance about PostgreSQL vs CrateDB JDBC drivers and integration notes. Replaces the inlined driver-options section in docs/connect/java/index.md with an include reference to the new file.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Reader
  participant Index as "docs/connect/index.md"
  participant ScalaPage as "docs/connect/scala/index.md"
  participant JavaIndex as "docs/connect/java/index.md"
  participant DriverOptions as "docs/connect/java/_driver_options.md"

  Reader->>Index: open Drivers page
  Note over Index: New Scala card added\nand toctree entry
  Index->>ScalaPage: navigate to Scala guide
  Reader->>ScalaPage: view build.sbt / example.scala / Cloud notes

  Reader->>JavaIndex: open Java driver page
  JavaIndex->>DriverOptions: include driver-options content
  Reader->>DriverOptions: read JDBC driver guidance
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–30 minutes

  • Check Scala example correctness (sbt coordinates, scalaVersion, JDBC usage and exception/resource handling).
  • Verify docs/connect/index.md grid markup and toctree path render as intended.
  • Confirm include path resolves and content parity with previous Java guidance.

Possibly related PRs

Suggested reviewers

  • seut
  • matriv

Poem

🐰 I hopped through lines of docs to play,
Placed Scala's card where drivers lay.
sbt and JDBC snug in a nook,
Examples ready — take a look! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title 'Driver: Add page about Scala' directly aligns with the main change in the changeset. The primary objective is to add a new Scala driver documentation page at docs/connect/scala/index.md, which is clearly reflected in the title. The title is concise, specific, and accurately summarizes the core contribution without unnecessary details.
Description check ✅ Passed The pull request description is related to the changeset. It states 'Adds a new guide page about Scala' and provides a preview link to the new documentation page. While the description is brief and somewhat informal ('What the title says'), it accurately reflects the main content changes in the pull request—specifically the addition of the new Scala documentation page at docs/connect/scala/index.md.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch scala

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6f2856 and 32a032b.

📒 Files selected for processing (1)
  • docs/connect/scala/index.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/connect/scala/index.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build docs

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

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

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the scala branch 2 times, most recently from fa8932a to c979f69 Compare October 16, 2025 21:01
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl requested review from kneth and surister October 16, 2025 22:12
@amotl amotl added new content New content being added. and removed cross linking Linking to different locations of the documentation. labels Oct 18, 2025
@amotl amotl force-pushed the scala branch 2 times, most recently from 54cc58a to d0cd537 Compare October 20, 2025 20:24
coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the scala branch 3 times, most recently from f3870e7 to 1d13e84 Compare October 21, 2025 12:54
@amotl amotl requested review from matriv and seut and removed request for kneth and surister October 31, 2025 22:44
@amotl amotl added the reorganize Moving content around, inside and between other systems. label Oct 31, 2025
}
```

:::{rubric} CrateDB Cloud
Copy link
Contributor

Choose a reason for hiding this comment

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

I have the same comment here as in the Erlang PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

Generalized in the same way with 32a032b, thanks.

@amotl amotl requested a review from matriv November 3, 2025 15:33
@amotl amotl merged commit ce8a9b1 into main Nov 3, 2025
3 checks passed
@amotl amotl deleted the scala branch November 3, 2025 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new content New content being added. reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants