KAFKA-5162: Add a reference to AdminClient to docs/api.html #2958
Conversation
docs/api.html
Outdated
| <version>0.10.2.0</version> | ||
| </dependency> | ||
| </pre> | ||
| For more information about the AdminClient APIs, see the <a href="/{{version}}/javadoc/index.html?org/apache/kafka/clients/AdminClient.html" title="Kafka 0.10.2 Javadoc">javadoc</a>. |
There was a problem hiding this comment.
Can we use `{{version}}`` in the title as well? If possible, it seems like we should do that for all 5 APIs.
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
docs/api.html
Outdated
| @@ -48,14 +49,14 @@ | |||
| The Consumer API allows applications to read streams of data from topics in the Kafka cluster. | |||
| <p> | |||
| Examples showing how to use the consumer are given in the | |||
| <a href="/{{version}}/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html" title="Kafka 0.10.2 Javadoc">javadocs</a>. | |||
| <a href="/{{version}}/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html" title="Kafka {{version}} Javadoc">javadocs</a>. | |||
There was a problem hiding this comment.
@ewencp, @guozhangwang Can you please confirm if it's OK to use {{version}} in the title too? Just want to confirm if it was intentional to hardcode the version number in the title.
There was a problem hiding this comment.
I just generated docs from this locally and it seems fine (which makes sense -- it's just a template so it should work anywhere). However, note that this doesn't quite match the original -- it now says "Kafka 0102 Javadoc".
There was a problem hiding this comment.
Thanks, @ewencp . Is there a variable that preserves the periods? Where are these variables defined?
|
retest this please |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
@cmccabe Yeah, dug around a bit and https://github.com/apache/kafka/blob/trunk/docs/js/templateData.js#L19-L22 implies you want |
Signed-off-by: Colin P. Mccabe <cmccabe@confluent.io>
|
Let's punt on the {{version}} thing for now to get this in. |
|
Oops, I just saw @ewencp's comment. dotVersion sounds like the right thing, I just pushed a patch for that. |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
| <version>{{dotVersion}}.0</version> | ||
| </dependency> | ||
| </pre> | ||
| For more information about the AdminClient APIs, see the <a href="/{{version}}/javadoc/index.html?org/apache/kafka/clients/AdminClient.html" title="Kafka {{dotVersion}} Javadoc">javadoc</a>. |
There was a problem hiding this comment.
I think the admin subpackage is missing. Fixed before merging.
No description provided.