Skip to content

Commit

Permalink
changed API documentation link to pkg.go.dev
Browse files Browse the repository at this point in the history
  • Loading branch information
emasab committed Jun 3, 2022
1 parent 5180815 commit b3caf60
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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/).

Expand Down
7 changes: 6 additions & 1 deletion kafka/README.md
Expand Up @@ -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.
Expand Down

0 comments on commit b3caf60

Please sign in to comment.