You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2026/09/24 17:48:05 UTC
(pekko-connectors-kafka) branch main updated: Point Kafka doc links at Kafka 4.3 docs (#666)
This is an automated email from the ASF dual-hosted git repository.
pjfanning pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko-connectors-kafka.git
The following commit(s) were added to refs/heads/main by this push:
new b3e9e69f Point Kafka doc links at Kafka 4.3 docs (#666)
b3e9e69f is described below
commit b3e9e69f3ebe0680e9fdae83887accbf5cff8b3d
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Thu Sep 24 18:48:01 2026 +0100
Point Kafka doc links at Kafka 4.3 docs (#666)
Motivation:
The docs linked to the Kafka 3.7 site. The Kafka website has been
rebuilt so documentation.html is now a JavaScript redirect page for
every version, and the #section anchors used in our docs no longer
exist there.
Modification:
Set KafkaVersionForDocs to 43 to match the kafka-clients 4.3.1
dependency. Repoint the extref links to the new doc pages (security,
SSL and Kerberos client config, consumer configs, introduction), use a
direct javadoc path for KafkaConsumer, and update the hard-coded
consumer assignment strategy and Kafka 3.0 upgrade notes links.
Result:
Kafka doc links go to the 4.3 docs and land on sections that exist.
Tests:
- sbt docs/paradox unidoc: success
- cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator.conf: exit 0, no kafka.apache.org issues
- curl of every kafka.apache.org URL in the generated site: all 200, all anchors present
References:
None - Kafka website restructure broke doc anchors
---
docs/src/main/paradox/consumer.md | 6 +++---
docs/src/main/paradox/home.md | 4 ++--
docs/src/main/paradox/production.md | 6 +++---
project/Versions.scala | 2 +-
4 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/src/main/paradox/consumer.md b/docs/src/main/paradox/consumer.md
index 2a897fce..c0366ea5 100644
--- a/docs/src/main/paradox/consumer.md
+++ b/docs/src/main/paradox/consumer.md
@@ -57,15 +57,15 @@ Important consumer settings
: | Setting | Description |
|-------------|----------------------------------------------|
| stop-timeout | The stage will delay stopping the internal actor to allow processing of messages already in the stream (required for successful committing). This can be set to 0 for streams using @apidoc[Consumer.DrainingControl] |
-| kafka-clients | Section for properties passed unchanged to the Kafka client (see @extref:[Kafka's Consumer Configs](kafka:/documentation.html#consumerconfigs)) |
+| kafka-clients | Section for properties passed unchanged to the Kafka client (see @extref:[Kafka's Consumer Configs](kafka:/configuration/consumer-configs/)) |
| connection-checker | Configuration to let the stream fail if the connection to the Kafka broker fails. |
-Explicitly selecting a [Consumer Assignment Strategy](https://kafka.apache.org/documentation/#consumerconfigs_partition.assignment.strategy) such as @javadoc[CooperativeStickyAssignor](org.apache.kafka.clients.consumer.CooperativeStickyAssignor) is recommended. They were introduced in [Kafka 3.0](https://kafka.apache.org/33/documentation.html#upgrade_300_notable). Please check the [Kafka upgrade guide](https://cwiki.apache.org/confluence/display/KAFKA/KIP-429:+Kafka+Consumer+Incremental+ [...]
+Explicitly selecting a @extref:[Consumer Assignment Strategy](kafka:/configuration/consumer-configs/#partition.assignment.strategy) such as @javadoc[CooperativeStickyAssignor](org.apache.kafka.clients.consumer.CooperativeStickyAssignor) is recommended. They were introduced in [Kafka 3.0](https://kafka.apache.org/39/getting-started/upgrade/#notable-changes-in-300). Please check the [Kafka upgrade guide](https://cwiki.apache.org/confluence/display/KAFKA/KIP-429:+Kafka+Consumer+Incremental+ [...]
reference.conf (HOCON)
: @@ snip [snip](/core/src/main/resources/reference.conf) { #consumer-settings }
-The Kafka documentation @extref:[Consumer Configs](kafka:/documentation.html#consumerconfigs) lists the settings, their defaults and importance. More detailed explanations are given in the @javadoc[KafkaConsumer](org.apache.kafka.clients.consumer.KafkaConsumer) API and constants are defined in @javadoc[ConsumerConfig](org.apache.kafka.clients.consumer.ConsumerConfig) API.
+The Kafka documentation @extref:[Consumer Configs](kafka:/configuration/consumer-configs/) lists the settings, their defaults and importance. More detailed explanations are given in the @javadoc[KafkaConsumer](org.apache.kafka.clients.consumer.KafkaConsumer) API and constants are defined in @javadoc[ConsumerConfig](org.apache.kafka.clients.consumer.ConsumerConfig) API.
### Programmatic construction
diff --git a/docs/src/main/paradox/home.md b/docs/src/main/paradox/home.md
index a77688c4..0d33b66d 100644
--- a/docs/src/main/paradox/home.md
+++ b/docs/src/main/paradox/home.md
@@ -22,7 +22,7 @@ These clients can communicate with brokers that are version 2.1.0 or newer. Olde
Check even Confluent's [Versions and Interoperability](https://docs.confluent.io/platform/current/installation/versions-interoperability.html) page for more details.
--- @extref:[Javadoc for `KafkaConsumer`](kafka:/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html)
+-- @extref:[Javadoc for `KafkaConsumer`](kafka:/javadoc/org/apache/kafka/clients/consumer/KafkaConsumer.html)
@@@
@@ -50,7 +50,7 @@ The table below shows Apache Pekko Connectors Kafka's direct dependencies and th
@@dependencies { projectId="core" }
* Apache Pekko Streams $pekko.version$ @extref[documentation](pekko:stream/index.html) and [sources](https://github.com/apache/pekko)
-* Apache Kafka client $kafka.version$ @extref[documentation](kafka:/documentation#index) and [sources](https://github.com/apache/kafka)
+* Apache Kafka client $kafka.version$ @extref[documentation](kafka:/getting-started/introduction/) and [sources](https://github.com/apache/kafka)
## Scala and Java APIs
diff --git a/docs/src/main/paradox/production.md b/docs/src/main/paradox/production.md
index f3bd4d4a..ef345ce1 100644
--- a/docs/src/main/paradox/production.md
+++ b/docs/src/main/paradox/production.md
@@ -18,12 +18,12 @@ This is just a start, please add your experiences to this list by [opening a Pul
## Security setup
-The different security setups offered by Kafka brokers are described in the @extref[Apache Kafka documentation](kafka:/documentation.html#security).
+The different security setups offered by Kafka brokers are described in the @extref[Apache Kafka documentation](kafka:/security/).
### SSL
-The properties described in Kafka's @extref[Configuring Kafka Clients for SSL](kafka:/documentation.html#security_configclients) go in the
+The properties described in Kafka's @extref[Configuring Kafka Clients for SSL](kafka:/security/encryption-and-authentication-using-ssl/#configuring-kafka-clients) go in the
`pekko.kafka.consumer.kafka-clients` and `pekko.kafka.producer.kafka-clients` sections of the configuration, or can be added programmatically via
`ProducerSettings.withProperties` and `ConsumerSettings.withProperties`. The necessary property name constants are available in @javadoc[SslConfigs](org.apache.kafka.common.config.SslConfigs).
@@ -47,7 +47,7 @@ You have the option to pass the passwords as command line parameters or environm
### Kerberos
-The properties described in Kafka's @extref[Configuring Kafka Clients for Kerberos](kafka:/documentation.html#security_sasl_kerberos_clientconfig) go in the
+The properties described in Kafka's @extref[Configuring Kafka Clients for Kerberos](kafka:/security/authentication-using-sasl/#configuring-kafka-clients) go in the
`pekko.kafka.consumer.kafka-clients` and `pekko.kafka.producer.kafka-clients` sections of the configuration, or can be added programmatically via
`ProducerSettings.withProperties` and `ConsumerSettings.withProperties`.
diff --git a/project/Versions.scala b/project/Versions.scala
index 13143596..d6f0e02d 100644
--- a/project/Versions.scala
+++ b/project/Versions.scala
@@ -25,7 +25,7 @@ object Versions {
val pekkoManagementVersionForDocs = "current"
val kafkaVersion = "4.3.1"
- val KafkaVersionForDocs = "37"
+ val KafkaVersionForDocs = "43"
val mockitoVersion = "5.24.0"
val scalaTestVersion = "3.2.20"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org