You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "devanshikhatsuriya (via GitHub)" <gi...@apache.org> on 2024/09/17 09:05:15 UTC
[PR] KAFKA-6197: Update Streams API and Javadoc references in documentation [kafka]
devanshikhatsuriya opened a new pull request, #17215:
URL: https://github.com/apache/kafka/pull/17215
Update the Streams heading links in documentation TOC to redirect to headings in the documentation, as redirecting to the newer streams landing page was confusing. Also added a section of Javadocs to the Streams landing page.
Reference for documentation changes - https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+Documentation+Changes
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-6197: Update Streams API and Javadoc references in documentation [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on PR #17215:
URL: https://github.com/apache/kafka/pull/17215#issuecomment-2380876650
Thanks for the PR! Merged to `trunk`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-6197: Update Streams API and Javadoc references in documentation [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #17215:
URL: https://github.com/apache/kafka/pull/17215#discussion_r1779743529
##########
docs/documentation.html:
##########
@@ -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>
Review Comment:
```suggestion
<p>To learn more about Kafka Streams, visit the <a href="/documentation/streams">Kafka Streams page</a>.</p>
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-6197: Update Streams API and Javadoc references in documentation [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax merged PR #17215:
URL: https://github.com/apache/kafka/pull/17215
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-6197: Update Streams API and Javadoc references in documentation [kafka]
Posted by "devanshikhatsuriya (via GitHub)" <gi...@apache.org>.
devanshikhatsuriya commented on PR #17215:
URL: https://github.com/apache/kafka/pull/17215#issuecomment-2354965119
@halorgium @astubbs @amir @alexism please take a look!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-6197: Update Streams API and Javadoc references in documentation [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on PR #17215:
URL: https://github.com/apache/kafka/pull/17215#issuecomment-2380876828
@devanshikhatsuriya -- do you happen to have a Jira account, so we can assign the ticket to you?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org