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.

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

KAFKA-13881: Add Streams package infos #12936

Merged
merged 3 commits into from Dec 27, 2022

Conversation

gharris1727
Copy link
Contributor

@gharris1727 gharris1727 commented Dec 1, 2022

Signed-off-by: Greg Harris greg.harris@aiven.io

Split off from #12895 to target only Streams packages.

There are currently no descriptions of packages in the javadocs, which can be intimidating to new users that look at the documentation and see a wall of raw package names. An example of this can be seen here: https://kafka.apache.org/31/javadoc/

This change adds the following package descriptions based on a best-effort reading of the existing javadocs. Please feel free to correct any factual errors in the proposed descriptions, I am not asserting that these descriptions are currently accurate. This PR only covers the streams packages.

For clarity of review, I'll summarize the new descriptions in a table. This summary may become stale by accident, so please be sure to view the diff itself or build the changes locally with ./gradlew javadoc.

Package Description
org.apache.kafka.streams Provides the Kafka Streams library for building streaming data applications.
org.apache.kafka.streams.errors Provides common exception classes for Streams applications.
org.apache.kafka.streams.kstream Provides a high-level programming model (DSL) to express a (stateful) data flow computation over input streams and tables.
org.apache.kafka.streams.processor Provides a low-level programming model (Processor API, aka, PAPI) to express a (stateful) data flow computation over input topics.
org.apache.kafka.streams.processor.api Provides a low-level programming model (Processor API, aka, PAPI) to express a (stateful) data flow computation over input topics.
org.apache.kafka.streams.query Provides a query API (aka Interactive Queries) over state stores, for extracting data from a stateful Kafka Streams application.
org.apache.kafka.streams.state Provides interfaces for managing the intermediate state of a stateful streams application.
org.apache.kafka.streams.test Provides classes for testing Kafka Streams applications with mocked inputs.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

Signed-off-by: Greg Harris <greg.harris@aiven.io>
@mimaison
Copy link
Member

@mjsax @ableegoldman Can you take a look? Thanks

@mjsax mjsax added the docs label Dec 27, 2022
@mjsax mjsax merged commit 8f0e6c6 into apache:trunk Dec 27, 2022
@mjsax
Copy link
Member

mjsax commented Dec 27, 2022

Thanks for the PR, @gharris1727.

Merged to trunk and cherry-picked to 3.4 branch.

mjsax pushed a commit that referenced this pull request Dec 27, 2022
Reviewers: Christo Lolov (@clolov), Matthias J. Sax <matthias@confluent.io>
guozhangwang pushed a commit to guozhangwang/kafka that referenced this pull request Jan 25, 2023
Reviewers: Christo Lolov (@clolov), Matthias J. Sax <matthias@confluent.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants