From c44c74b3bdc20f3b732973fae497e73932db5aa1 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Tue, 23 Sep 2025 20:18:13 +0200 Subject: [PATCH 1/2] Drivers: Fix broken links Apparently, the Sphinx link checker currently does not scan Markdown By-Reference links [1]. Why? [1] https://www.ii.com/links-footnotes-markdown/ --- docs/connect/drivers.md | 6 ++++++ docs/connect/index.md | 2 -- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/connect/drivers.md b/docs/connect/drivers.md index 8d7c0b0e..8d6f512e 100644 --- a/docs/connect/drivers.md +++ b/docs/connect/drivers.md @@ -8,6 +8,7 @@ This section lists drivers and adapters for supported programming languages, frameworks, and environments. ## PostgreSQL + The drivers listed in this section all use the [CrateDB PostgreSQL interface]. ::::{sd-table} @@ -218,6 +219,7 @@ For connecting to CrateDB from Python, supporting Python's async implementations ## HTTP + The drivers listed in this section all use the [CrateDB HTTP interface]. ::::{sd-table} @@ -378,3 +380,7 @@ Ruby on Rails ActiveRecord adapter for CrateDB. Please visit the {ref}`build-status` page for an overview about the integration status of the client drivers listed above, and more. ``` + + +[CrateDB HTTP interface]: inv:crate-reference:*:label#interface-http +[CrateDB PostgreSQL interface]: inv:crate-reference:*:label#interface-postgresql diff --git a/docs/connect/index.md b/docs/connect/index.md index 130004d0..a1d20dc2 100644 --- a/docs/connect/index.md +++ b/docs/connect/index.md @@ -134,8 +134,6 @@ ruby [Authentication]: inv:crate-reference:*:label#admin_auth [Bulk operations]: inv:crate-reference:*:label#http-bulk-ops [CrateDB Examples]: https://github.com/crate/cratedb-examples -[CrateDB HTTP interface]: inv:crate-reference:*:label#interface-http -[CrateDB PostgreSQL interface]: inv:crate-reference:*:label#interface-postgresql [HTTP interface]: inv:crate-reference:*:label#interface-http [HTTP protocol]: https://en.wikipedia.org/wiki/HTTP [JDBC]: https://en.wikipedia.org/wiki/Java_Database_Connectivity From 565cf961f398b67fea7d862ca6823354aa9117d8 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Tue, 23 Sep 2025 20:18:30 +0200 Subject: [PATCH 2/2] Drivers: Improve wording in headline --- docs/connect/drivers.md | 2 +- docs/connect/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/connect/drivers.md b/docs/connect/drivers.md index 8d6f512e..388a5d15 100644 --- a/docs/connect/drivers.md +++ b/docs/connect/drivers.md @@ -1,5 +1,5 @@ (connect-drivers)= -# Drivers and Client Libraries +# All drivers and client libraries :::{include} /_include/links.md ::: diff --git a/docs/connect/index.md b/docs/connect/index.md index a1d20dc2..63bfe3d9 100644 --- a/docs/connect/index.md +++ b/docs/connect/index.md @@ -94,7 +94,7 @@ Database connectivity options and tools. - {ref}`connect-php` - {ref}`connect-python` - {ref}`connect-ruby` -- {ref}`connect-drivers` +- Overview: {ref}`connect-drivers` All available CrateDB drivers and adapters for supported programming languages, frameworks, and environments.