gharris1727 opened a new pull request, #12895: URL: https://github.com/apache/kafka/pull/12895
Signed-off-by: Greg Harris <greg.har...@aiven.io> 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.clients.admin|Kafka Client for performing administrative operations on a Kafka cluster org.apache.kafka.clients.consumer|Kafka Client for consuming events from a Kafka Cluster org.apache.kafka.clients.producer|Kafka client for producing events to a Kafka Cluster org.apache.kafka.common|Shared functionality for Kafka client libraries org.apache.kafka.common.acl|Access Control List API for Authorization of Kafka Clients org.apache.kafka.common.annotation|Annotations for describing properties of Kafka classes org.apache.kafka.common.config|Standard mechanisms for defining, parsing, validating, and documenting user-configurable parameters org.apache.kafka.common.config.provider|Pluggable interface and implementations for late-binding in configuration values org.apache.kafka.common.errors|Errors that are thrown by Kafka Clients org.apache.kafka.common.header|API for application defined metadata attached to Kafka events org.apache.kafka.common.metrics|Mechanisms for emitting monitoring metrics from Kafka Server and Clients org.apache.kafka.common.metrics.stats|Methods of statistically aggregating metrics upon emission org.apache.kafka.common.quota|Mechanisms for enforcing resource quotas on Kafka Clients org.apache.kafka.common.resource|Client handles representing logical resources in a Kafka Cluster org.apache.kafka.common.security.auth|Pluggable interface for implementing generic Kafka authentication mechanisms org.apache.kafka.common.security.oauthbearer|Adaptor for using OAuth Bearer Token Authentication to secure a Kafka Cluster org.apache.kafka.common.security.oauthbearer.secured|Deprecated org.apache.kafka.common.security.plain|Implementation to use plaintext credentials authentication to secure a Kafka cluster org.apache.kafka.common.security.scram|Adaptor to use the Salted Challenge Response Authentication Mechanism to secure Kafka clusters org.apache.kafka.common.security.token.delegation|API for delegating authorization to a distinct Principal to secure a Kafka Cluster org.apache.kafka.common.serialization|Interface and implementations of serialization/deserialization routines for various objects org.apache.kafka.server.authorizer|Pluggable mechanism for performing authorization on a Kafka Server org.apache.kafka.server.policy|Data model for authorization policies org.apache.kafka.server.quota|Pluggable interface for enforcing client quotas from a Kafka Server ### 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
