Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Jan 22, 2026

Just maintenance.

@amotl amotl requested a review from matriv January 22, 2026 01:46
@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

Walkthrough

Standardizes SSL guidance across multiple connect guides: renames several "CrateDB Cloud" rubrics to "SSL connection", consolidates SSL/sslmode instructions into div-wrapped guidance, adjusts example connection strings (Sslmode placement/values), adds CrateDB Cloud notes, and inserts/removes repeated include blocks and minor formatting fixes.

Changes

Cohort / File(s) Summary
Top-level includes & misc connect pages
docs/connect/groovy/index.md, docs/connect/julia/index.md, docs/connect/kotlin/index.md, docs/connect/perl/index.md, docs/connect/scala/index.md, docs/connect/zig/index.md, docs/connect/ruby.md
Added a global include at file top where missing, removed duplicated include blocks, and applied minor formatting cleanup.
SSL rubric renames & wording standardization
docs/connect/csharp/index.md, docs/connect/fsharp/index.md, docs/connect/visualbasic/index.md, docs/connect/rust/index.md, docs/connect/scala/index.md, docs/connect/groovy/index.md, docs/connect/julia/index.md, docs/connect/kotlin/index.md, docs/connect/perl/index.md, docs/connect/zig/index.md, docs/connect/elixir/index.md, docs/connect/r/index.md
Renamed rubric headers to "SSL connection", wrapped guidance in :::{div} blocks, unified wording to recommend sslmode=require (or equivalent TLS instructions), reordered placeholders, and added explicit CrateDB Cloud note/link.
Erlang drivers
docs/connect/erlang/epgsql.md, docs/connect/erlang/odbc.md
Adjusted examples (added ssl => false or appended ;Sslmode=...;), moved Sslmode placement in strings, and consolidated SSL guidance into a div including Cloud variant note.
Go driver guides
docs/connect/go/ksql.md, docs/connect/go/pgx.md, docs/connect/go/pq.md
Consolidated SSL instruction into a single div-wrapped paragraph using sslmode=require, moved Cloud note inside the block, and applied minor formatting tweaks.
Java JDBC guides
docs/connect/java/cratedb-jdbc.md, docs/connect/java/postgresql-jdbc.md
Merged SSL guidance into a div paragraph and added the CrateDB Cloud variant sentence inside that block; minor example/format adjustments.
ODBC & Python ODBC examples
docs/connect/odbc/csharp.md, docs/connect/odbc/python.md
Updated connection strings to include Sslmode placement (e.g., appended Sslmode=disable/Sslmode=require), reorganized UID/Pwd/MaxVarcharSize segments for pyodbc/turbodbc, and wrapped SSL guidance in rubric/div markup.
Elixir, Ruby & other client pages
docs/connect/elixir/index.md, docs/connect/ruby.md, docs/connect/fsharp/index.md, docs/connect/visualbasic/index.md
Replaced muted headings with div wrappers, standardized SSL guidance formatting, moved Cloud references into inline links or into the new div blocks, and updated example connection strings to reflect sslmode=require.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • matriv
  • seut
  • surister

Poem

🐰 I hopped through docs both near and far,
Tweaked rubrics, wrapped notes in a div so par.
"Sslmode=require" I hum with a grin,
Cloud-ready examples tucked safely within.
Hooray — the guides now sparkle like a star!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: unifying SSL connection section wording across documentation pages.
Description check ✅ Passed The description is minimal but related to the changeset; it refers to the changes as 'maintenance,' which aligns with the PR's maintenance-focused refactoring work.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch drivers-refinements

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/connect/odbc/python.md`:
- Around line 88-89: The pyodbc connection string example should mirror the
turbodbc format by placing credentials (Driver/Server/Port/Uid/Pwd) on the first
concatenated string and protocol/options (MaxVarcharSize/Sslmode) on the second;
update the pyodbc example's two-line string so the first line contains
"Driver=...;Server=...;Port=...;Uid=...;Pwd=..." and the second line contains
"MaxVarcharSize=...;Sslmode=...;", preserving the backslash concatenation and
quoting used in the existing pyodbc example so both ODBC examples follow the
same pattern.

@amotl amotl requested a review from seut January 22, 2026 11:15
Copy link
Member

@seut seut left a comment

Choose a reason for hiding this comment

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

thx!

your environment.
Use the `Sslmode=require` parameter, and replace username, password,
and hostname with values matching your environment.
Also use this variant to connect to CrateDB Cloud.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe interesting to add a link for CrateDB Cloud, so it's also highlighted? (As this is important for cloud users). If you agree, please change everywhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

Addressed with 85f8778, thanks.

@amotl amotl force-pushed the drivers-refinements branch from 179abd9 to 85f8778 Compare January 22, 2026 20:37
@amotl amotl added sanding-1200 Fine sanding. maintenance C'est la vie. labels Jan 22, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@docs/connect/kotlin/index.md`:
- Around line 1-2: Remove the duplicate include of links.md: there are two
occurrences of the include directive (:::{include} /_include/links.md), so
delete the redundant directive and keep only a single include of links.md in the
document to prevent duplicate reference warnings.

In `@docs/connect/odbc/python.md`:
- Around line 38-41: The connection string assigned to connection_string
concatenates two literals but is missing a semicolon between the Pwd and
MaxVarcharSize tokens causing "Pwd=crateMaxVarcharSize=..."; fix by inserting a
semicolon into the literal boundary (either append ";" to the end of the
fragment containing "Pwd=crate" or prepend ";" to the fragment containing
"MaxVarcharSize") so the final connection_string correctly contains
"...Pwd=crate;MaxVarcharSize=...".

In `@docs/connect/ruby.md`:
- Around line 1-2: Update the mismatched Markdown reference so the link label
capitalization is consistent: change either the reference usage "[our GitHub
documentation]" or the definition "[our github documentation]" so both labels
match exactly (case-sensitive) in the docs/connect/ruby.md content; ensure the
reference definition and the inline reference text use identical capitalization
to restore the link.
🧹 Nitpick comments (1)
docs/connect/fsharp/index.md (1)

1-1: Remove duplicate [CrateDB Cloud] reference definitions from individual files.

Multiple documentation files define [CrateDB Cloud] locally (e.g., docs/integrate/cluvio/usage.md:233, docs/integrate/superset/index.md:179), even though the canonical definition already exists in docs/_include/links.md:20. These duplicate definitions should be removed to maintain consistency and reduce maintenance burden. References should rely solely on the include file.

The 84 build warnings are likely MD053 (unused reference-style links) from markdownlint, which are already disabled in the include file and should not block the merge per documentation conversion best practices.

@amotl amotl added the cross linking Linking to different locations of the documentation. label Jan 22, 2026
@amotl amotl merged commit ccef1ee into main Jan 22, 2026
3 checks passed
@amotl amotl deleted the drivers-refinements branch January 22, 2026 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross linking Linking to different locations of the documentation. maintenance C'est la vie. sanding-1200 Fine sanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants