Connect: Unify wording of "SSL connection" sections across pages#536
Merged
Connect: Unify wording of "SSL connection" sections across pages#536
Conversation
WalkthroughStandardizes 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
Sequence Diagram(s)(omitted) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
seut
approved these changes
Jan 22, 2026
docs/connect/csharp/index.md
Outdated
| 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. |
Member
There was a problem hiding this comment.
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.
amotl
force-pushed
the
drivers-refinements
branch
from
179abd9 to
85f8778
Compare
There was a problem hiding this comment.
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 indocs/_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
added
the
cross linking
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
2 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.
Just maintenance.