You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mj...@apache.org on 2024/09/28 19:43:06 UTC

(kafka) branch trunk updated: KAFKA-6197: Update Streams API and Javadoc references in documentation (#17215)

This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 235cafa805e KAFKA-6197: Update Streams API and Javadoc references in documentation (#17215)
235cafa805e is described below

commit 235cafa805ee5e52e1bca0c5151daf336fc96eed
Author: devanshikhatsuriya <65...@users.noreply.github.com>
AuthorDate: Sun Sep 29 01:12:59 2024 +0530

    KAFKA-6197: Update Streams API and Javadoc references in documentation (#17215)
    
    Reviewers: Matthias J. Sax <ma...@confluent.io>
---
 docs/api.html           | 6 +++---
 docs/documentation.html | 4 ++--
 docs/streams/index.html | 1 +
 docs/toc.html           | 4 ++--
 4 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/docs/api.html b/docs/api.html
index 7b74d045520..8f76bbc7036 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -57,10 +57,10 @@
 
 	<h3 class="anchor-heading"><a id="streamsapi" class="anchor-link"></a><a href="#streamsapi">2.3 Streams API</a></h3>
 
-	The <a href="#streamsapi">Streams</a> API allows transforming streams of data from input topics to output topics.
+	The <a href="/{{version}}/documentation/streams">Streams</a> API allows transforming streams of data from input topics to output topics.
 	<p>
 	Examples showing how to use this library are given in the
-	<a href="/{{version}}/javadoc/index.html?org/apache/kafka/streams/KafkaStreams.html" title="Kafka {{dotVersion}} Javadoc">javadocs</a>
+	<a href="/{{version}}/javadoc/index.html?org/apache/kafka/streams/KafkaStreams.html" title="Kafka {{dotVersion}} Javadoc">javadocs</a>.
 	<p>
 	Additional documentation on using the Streams API is available <a href="/{{version}}/documentation/streams">here</a>.
 	<p>
@@ -75,7 +75,7 @@
 	<p>
 	When using Scala you may optionally include the <code>kafka-streams-scala</code> library.  Additional documentation on using the Kafka Streams DSL for Scala is available <a href="/{{version}}/documentation/streams/developer-guide/dsl-api.html#scala-dsl">in the developer guide</a>.
 	<p>
-	To use Kafka Streams DSL for Scala for Scala {{scalaVersion}} you can use the following maven dependency:
+	To use Kafka Streams DSL for Scala {{scalaVersion}} you can use the following maven dependency:
 
 	<pre class="line-numbers"><code class="language-xml">&lt;dependency&gt;
 	&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
diff --git a/docs/documentation.html b/docs/documentation.html
index c3dbcf32cad..2370a6a8c8f 100644
--- a/docs/documentation.html
+++ b/docs/documentation.html
@@ -104,7 +104,7 @@
     <h2 class="anchor-heading"><a id="connect" class="anchor-link"></a><a href="#connect">8. Kafka Connect</a></h2>
     <!--#include virtual="connect.html" -->
 
-    <h2><a id="streams" href="/documentation/streams">9. Kafka Streams</a></h2>
+    <h2><a id="streams" href="#streams">9. Kafka Streams</a></h2>
     <p>
         Kafka Streams is a client library for processing and analyzing data stored in Kafka. It builds upon important stream processing concepts such as properly distinguishing between event time and processing time, windowing support, exactly-once processing semantics and simple yet efficient management of application state.
     </p>
@@ -112,7 +112,7 @@
         Kafka Streams has a <b>low barrier to entry</b>: You can quickly write and run a small-scale proof-of-concept on a single machine; and you only need to run additional instances of your application on multiple machines to scale up to high-volume production workloads. Kafka Streams transparently handles the load balancing of multiple instances of the same application by leveraging Kafka's parallelism model.
     </p>
 
-    <p>Learn More about Kafka Streams read <a href="/documentation/streams">this</a> Section.</p>
+    <p>To learn more about Kafka Streams, visit the <a href="/documentation/streams">Kafka Streams page</a>.</p>
 
 <!--#include virtual="../includes/_footer.htm" -->
 <!--#include virtual="../includes/_docs_footer.htm" -->
diff --git a/docs/streams/index.html b/docs/streams/index.html
index e7f84c141bb..476c2fcd1af 100644
--- a/docs/streams/index.html
+++ b/docs/streams/index.html
@@ -45,6 +45,7 @@
                 <a href="/{{version}}/documentation/streams/core-concepts">Concepts</a>
                 <a href="/{{version}}/documentation/streams/architecture">Architecture</a>
                 <a href="/{{version}}/documentation/streams/developer-guide/">Developer Guide</a>
+                <a href="/{{version}}/javadoc/index.html?org/apache/kafka/streams/KafkaStreams.html">Javadoc</a>
                 <a href="/{{version}}/documentation/streams/upgrade-guide">Upgrade</a>
             </div>
         </div>
diff --git a/docs/toc.html b/docs/toc.html
index c05de6d17f0..af670a8de7e 100644
--- a/docs/toc.html
+++ b/docs/toc.html
@@ -34,7 +34,7 @@
             <ul>
                 <li><a href="#producerapi">2.1 Producer API</a>
                 <li><a href="#consumerapi">2.2 Consumer API</a>
-                <li><a href="/{{version}}/documentation/streams">2.3 Streams API</a>
+                <li><a href="#streamsapi">2.3 Streams API</a>
                 <li><a href="#connectapi">2.4 Connect API</a>
                 <li><a href="#adminapi">2.5 Admin API</a>
             </ul>
@@ -239,7 +239,7 @@
                 <li><a href="#connect_administration">8.4 Administration</a>
             </ul>
         
-        <li><a href="/{{version}}/documentation/streams">9. Kafka Streams</a>
+        <li><a href="#streams">9. Kafka Streams</a>
             <ul>
                 <li><a href="/{{version}}/documentation/streams/quickstart">9.1 Play with a Streams Application</a>
                 <li><a href="/{{version}}/documentation/streams/tutorial">9.2 Write your own Streams Applications</a>