kafka-jira mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Guozhang Wang (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (KAFKA-6197) Difficult to get to the Kafka Streams javadocs
Date Sat, 11 Nov 2017 00:59:00 GMT

     [ https://issues.apache.org/jira/browse/KAFKA-6197?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Guozhang Wang updated KAFKA-6197:
    Affects Version/s:

> Difficult to get to the Kafka Streams javadocs
> ----------------------------------------------
>                 Key: KAFKA-6197
>                 URL: https://issues.apache.org/jira/browse/KAFKA-6197
>             Project: Kafka
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 1.0.0,
>            Reporter: James Cheng
> In order to get to the javadocs for the Kafka producer/consumer/streams, I typically
go to http://kafka.apache.org/documentation/ and click on either 2.1 2.2 or 2.3 in the table
of contents to go right to appropriate section.
> The link for "Streams API" now goes to the (very nice) http://kafka.apache.org/10/documentation/streams/.
That page doesn't have a direct link to the Javadocs anywhere. The examples and guides actually
frequently mention "See javadocs for details" but there are no direct links to it.
> If I instead go back to the main page and scroll directly to section 2.3, there is still
the link to get to the javadocs. But it's harder to jump immediately to it. And it's a little
confusing that section 2.3 in the table of contents does not link you to section 2.3 of the
> It would be nice if the link to the Streams javadocs was easier to get to.

This message was sent by Atlassian JIRA

View raw message