From b3caf60d9e0c1f46167a2bd7c8786a505032c714 Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Fri, 3 Jun 2022 20:34:54 +0200 Subject: [PATCH] changed API documentation link to pkg.go.dev --- README.md | 2 +- kafka/README.md | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b83a7045..289be3433 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ pace with core Apache Kafka and components of the [Confluent Platform](https://w The Golang bindings provides a high-level Producer and Consumer with support for the balanced consumer groups of Apache Kafka 0.9 and above. -See the [API documentation](http://docs.confluent.io/current/clients/confluent-kafka-go/index.html) for more information. +See the [API documentation](https://pkg.go.dev/github.com/confluentinc/confluent-kafka-go/kafka#section-documentation) for more information. For a step-by-step guide on using the client see [Getting Started with Apache Kafka and Golang](https://developer.confluent.io/get-started/go/). diff --git a/kafka/README.md b/kafka/README.md index 396b34170..3a3d6c1f6 100644 --- a/kafka/README.md +++ b/kafka/README.md @@ -62,7 +62,12 @@ these tags should be specified on the **application** build/get/install command. -## Generating HTML documentation +## Generating HTML documentation (deprecated) + +Replacement: the pkg.go.dev auto generated API documentation +[API documentation](https://pkg.go.dev/github.com/confluentinc/confluent-kafka-go/kafka#section-documentation) + + To generate one-page HTML documentation run the mk/doc-gen.py script from the top-level directory. This script requires the beautifulsoup4 Python package.