Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

KAFKA-6197: Update Streams API and Javadoc references in documentation #17215

Merged
merged 4 commits into from
Sep 28, 2024
Merged

KAFKA-6197: Update Streams API and Javadoc references in documentation #17215

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc103fd
update streams api references
devanshikhatsuriya Sep 17, 2024
43ad5fc
update streams api references
devanshikhatsuriya Sep 17, 2024
a42b934
Merge branch 'devanshik-sandbox' of https://github.com/devanshikhatsu…
devanshikhatsuriya Sep 17, 2024
b2b16b4
Update docs/documentation.html
mjsax Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ <h3 class="anchor-heading"><a id="consumerapi" class="anchor-link"></a><a href="

<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>
Expand All @@ -75,7 +75,7 @@ <h3 class="anchor-heading"><a id="streamsapi" class="anchor-link"></a><a href="#
<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;
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,15 @@ <h2 class="anchor-heading"><a id="security" class="anchor-link"></a><a href="#se
<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>
<p>
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 <a href="/documentation/streams">this</a> page.</p>
mjsax marked this conversation as resolved.
Show resolved Hide resolved

<!--#include virtual="../includes/_footer.htm" -->
<!--#include virtual="../includes/_docs_footer.htm" -->
1 change: 1 addition & 0 deletions docs/streams/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ <h1>Kafka Streams</h1>
<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>
Expand Down
4 changes: 2 additions & 2 deletions docs/toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down