gharris1727 opened a new pull request, #12937: URL: https://github.com/apache/kafka/pull/12937
Signed-off-by: Greg Harris <greg.har...@aiven.io> Split off from #12895 to target only Connect 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. Currently the only package with new descriptions is clients, and I will be adding commits to this PR to address missing descriptions in the other packages (connect, core, streams) 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.connect.components|Provides common interfaces used to describe pluggable components. org.apache.kafka.connect.connector|Provides pluggable interfaces for Connector and Task implementations. org.apache.kafka.connect.connector.policy|Provides pluggable interfaces for connector security policies. org.apache.kafka.connect.data|Provides classes for representing data and schemas handled by Connect. org.apache.kafka.connect.errors|Provides common exception classes for Connect. org.apache.kafka.connect.header|Provides API for application-defined metadata attached to Connect records. org.apache.kafka.connect.health|Provides interface for describing the state of a running Connect cluster. org.apache.kafka.connect.rest|Provides pluggable interface for altering the behavior of the Connect REST API. org.apache.kafka.connect.sink|Provides API for implementing connectors which write Kafka records to external applications. org.apache.kafka.connect.source|Provides API for implementing connectors which read data from external applications into Kafka. org.apache.kafka.connect.storage|Provides pluggable interfaces and some implementations for (de)serializing data to and from Kafka org.apache.kafka.connect.transforms|Provides pluggable interface for altering data which is being moved by Connect. org.apache.kafka.connect.transforms.predicates|Provides pluggable interface for describing when a Transformation should be applied to a record. org.apache.kafka.connect.util|Provides common utilities that can be used in component implementations. ### 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-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
