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
mjsax
merged 3 commits into
apache:trunk
from
gharris1727:kafka-13881-streams-package-info
Dec 27, 2022
Merged
KAFKA-13881: Add Streams package infos #12936
mjsax
merged 3 commits into
apache:trunk
from
gharris1727:kafka-13881-streams-package-info
Dec 27, 2022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Greg Harris <greg.harris@aiven.io>
clolov
approved these changes
Dec 2, 2022
@mjsax @ableegoldman Can you take a look? Thanks |
mjsax
reviewed
Dec 27, 2022
streams/src/main/java/org/apache/kafka/streams/kstream/package-info.java
Outdated
Show resolved
Hide resolved
mjsax
reviewed
Dec 27, 2022
streams/src/main/java/org/apache/kafka/streams/processor/api/package-info.java
Outdated
Show resolved
Hide resolved
mjsax
reviewed
Dec 27, 2022
streams/src/main/java/org/apache/kafka/streams/processor/package-info.java
Outdated
Show resolved
Hide resolved
mjsax
reviewed
Dec 27, 2022
streams/src/main/java/org/apache/kafka/streams/query/package-info.java
Outdated
Show resolved
Hide resolved
mjsax
reviewed
Dec 27, 2022
streams/test-utils/src/main/java/org/apache/kafka/streams/test/package-info.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Greg Harris <greg.harris@aiven.io>
Thanks for the PR, @gharris1727. Merged to |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
.Committer Checklist (excluded from commit message)