Fix links on "drivers" page #228
Conversation
WalkthroughThis update adds three new markdown link references in a shared links include file, incorporates that include into the drivers documentation, and adjusts the Connect index documentation by reorganizing text and updating link formatting. No technical content or code logic was changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/_include/links.md (1)
8-10: Consider consolidating “BLOB” link aliases to avoid duplication
[CrateDB BLOBs]points to the same target as[BLOBs]defined elsewhere (docs/connect/index.md). Having two distinct reference names for the identical anchor makes future maintenance harder and invites drift.If both variants must stay, add an explicit alias in this central include so every document can reuse either form without redefining it locally:
+[BLOBs]: inv:crate-reference:*:label#blob_support # alias → same targetThen drop any local re-definitions of
[BLOBs].docs/connect/drivers.md (1)
367-368: Move Python example link definitions into the shared links includeThese two reference-style links are now only used in this file, but will very likely be referenced from other pages (e.g. language-specific guides). Relocating them to
/_include/links.mdkeeps redundancy low and prevents copy-paste drift.- [python-dbapi-by-example]: inv:crate-python:*:label#by-example - [python-sqlalchemy-by-example]: inv:sqlalchemy-cratedb:*:label#by-example(append the same lines to
docs/_include/links.mdinstead).docs/connect/index.md (1)
35-36: Two different link labels for BLOBs – unify for clarityThis page now uses
[CrateDB BLOBs]while the reference list at the bottom still defines[BLOBs], both resolving to the same anchor. Pick one canonical label (see earlier comment inlinks.md) to minimise cognitive overhead and eliminate duplicate link maintenance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/_include/links.md(1 hunks)docs/connect/drivers.md(2 hunks)docs/connect/index.md(2 hunks)
🧰 Additional context used
🧠 Learnings (7)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Learnt from: amotl
PR: crate/cratedb-guide#222
File: docs/integrate/powerbi/index.md:16-23
Timestamp: 2025-08-06T02:11:46.794Z
Learning: The `project:` role in MyST Markdown syntax like `[](project:#powerbi-desktop)` and `[](project:#powerbi-service)` is valid cross-reference syntax in the CrateDB Guide repository's MyST Markdown setup.
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/_include/links.mddocs/connect/index.mddocs/connect/drivers.md
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/_include/links.mddocs/connect/index.mddocs/connect/drivers.md
📚 Learning: the `project:` role in myst markdown syntax like `[](project:#powerbi-desktop)` and `[](project:#pow...
Learnt from: amotl
PR: crate/cratedb-guide#222
File: docs/integrate/powerbi/index.md:16-23
Timestamp: 2025-08-06T02:11:46.794Z
Learning: The `project:` role in MyST Markdown syntax like `[](project:#powerbi-desktop)` and `[](project:#powerbi-service)` is valid cross-reference syntax in the CrateDB Guide repository's MyST Markdown setup.
Applied to files:
docs/_include/links.md
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
Learnt from: amotl
PR: crate/cratedb-guide#207
File: docs/integrate/etl/iceberg-risingwave.md:205-207
Timestamp: 2025-06-05T14:29:15.512Z
Learning: The `records.Database("crate://", echo=True)` connection string for CrateDB works with defaults: localhost as host, "crate" as user, and blank password. This is valid and functional code in the records library.
Applied to files:
docs/_include/links.mddocs/connect/index.mddocs/connect/drivers.md
📚 Learning: in cratedb connection strings, the user:password@ syntax is valid for http basic authentication on p...
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.416Z
Learning: In CrateDB connection strings, the user:password@ syntax is valid for HTTP Basic authentication on port 4200, but PostgreSQL JDBC drivers do not support this format and require credentials as query parameters (?user=<user>&password=<password>) instead.
Applied to files:
docs/_include/links.mddocs/connect/index.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/connect/index.md
🔇 Additional comments (2)
docs/connect/drivers.md (2)
4-5:includedirective placement looks good – verify local link duplicatesThe links snippet is now included right after the title, which is consistent with
connect/index.md.
Just double-check the build for Sphinx “duplicate target name” warnings – especially for labels already provided by the include (e.g.[CrateDB PostgreSQL interface],[Bulk operations], etc.).
303-306: Link text reuses central definition correctly – niceUsing
[CrateDB BLOBs]here removes the prior hard-coded URL and leverages the shared inventory entry.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/_include/links.md (1)
9-9: Consider silencing markdownlint MD053 for the shared include file.
markdownlint-cli2flags these entries as “unused” because it analyses files in isolation and does not realise that every consumer does:::{include} /_include/links.md.
To avoid recurring noise in CI you could add a per-file.markdownlint-disable MD053at the top of this include, or exclude the folder in the linter config.Also applies to: 48-49
docs/connect/index.md (2)
33-36: Minor wording: shorten repeated product name.
[CrateDB BLOBs]already conveys the product; preceding “CrateDB bulk operations and” can read smoother as simply “bulk operations and [BLOBs]”.- bulk operations and [CrateDB BLOBs], which are not supported by the PostgreSQL + bulk operations and [BLOBs][CrateDB BLOBs], which are not supported by the PostgreSQLYour call—pure wording nit.
57-64: Reference list entry is now redundant with the inline link.You now link to BLOB support in the body (Line 35). Keeping a second list entry is fine, but if you prefer brevity you could drop it:
- - [BLOB support][CrateDB BLOBs]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/_include/links.md(2 hunks)docs/connect/drivers.md(1 hunks)docs/connect/index.md(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/connect/drivers.md
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/_include/links.mddocs/connect/index.md
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/_include/links.mddocs/connect/index.md
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
Learnt from: amotl
PR: crate/cratedb-guide#207
File: docs/integrate/etl/iceberg-risingwave.md:205-207
Timestamp: 2025-06-05T14:29:15.512Z
Learning: The `records.Database("crate://", echo=True)` connection string for CrateDB works with defaults: localhost as host, "crate" as user, and blank password. This is valid and functional code in the records library.
Applied to files:
docs/_include/links.mddocs/connect/index.md
📚 Learning: in cratedb connection strings, the user:password@ syntax is valid for http basic authentication on p...
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.416Z
Learning: In CrateDB connection strings, the user:password@ syntax is valid for HTTP Basic authentication on port 4200, but PostgreSQL JDBC drivers do not support this format and require credentials as query parameters (?user=<user>&password=<password>) instead.
Applied to files:
docs/_include/links.mddocs/connect/index.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/connect/index.md
🪛 markdownlint-cli2 (0.17.2)
docs/_include/links.md
9-9: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb blobs"
(MD053, link-image-reference-definitions)
48-48: Link and image reference definitions should be needed
Unused link or image reference definition: "python-dbapi-by-example"
(MD053, link-image-reference-definitions)
49-49: Link and image reference definitions should be needed
Unused link or image reference definition: "python-sqlalchemy-by-example"
(MD053, link-image-reference-definitions)
docs/connect/index.md
63-63: Reference links and images should use a label that is defined
Missing link or image reference definition: "cratedb blobs"
(MD052, reference-links-images)
⏰ 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
🔇 Additional comments (2)
docs/_include/links.md (1)
9-9: Verify intersphinx target IDs exist (blob_support,by-example).The three new definitions use intersphinx targets. Please make sure that
crate-referenceactually exposes a labelblob_support, and- the two by-example pages are still published under the same labels in the
crate-pythonandsqlalchemy-cratedbinventories.If any of those labels disappeared or changed, we will get broken links at build time.
Also applies to: 48-49
docs/connect/index.md (1)
7-9: Good relocation of the intro paragraph.Moving the text below the shared links include keeps link definitions in scope and solves the earlier MD052 warning.
1 participant
This patch mitigates a few hiccups after the recent migration into this repository.