[GitHub] [kafka] C0urante commented on a diff in pull request #12937: KAFKA-13881: Add Connect package infos

[GitBox]

C0urante commented on code in PR #12937:
URL: https://github.com/apache/kafka/pull/12937#discussion_r1044592612


##########
connect/api/src/main/java/org/apache/kafka/connect/connector/policy/package-info.java:
##########
@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Provides pluggable interfaces for connector security policies.

Review Comment:
   The issue I'd like to address is that the wording "interfaces for connector 
security policies" could cover many things that have nothing to do with the 
connector client config override policy mechanism, and doesn't really cover the 
client override mechanism that well. For example, one might think that this 
package refers to a way to set up ACLs on your Connect cluster, or bring up a 
connector with TLS.
   
   With regards to real-estate, the behavior I see when building these locally 
is that on the Javadoc landing page, where descriptions for all packages are 
listed, only the first sentence of each description is displayed:
   
   <img width="837" alt="Screen Shot 2022-12-09 at 10 50 46" 
src="https://user-images.githubusercontent.com/8636148/206740592-8cbf01db-a839-4e3f-b662-b1fef8edf067.png";>
   
   And on the dedicated page for a specific package, the entire description is 
displayed with what seems like enough space to go around:
   
   <img width="836" alt="Screen Shot 2022-12-09 at 10 51 54" 
src="https://user-images.githubusercontent.com/8636148/206740805-1be31370-376b-40c5-889e-9f6618d59181.png";>
   
   I should note that there was a mistake in my original suggestion; I 
definitely don't think that "Connector and Task implementations" is better than 
"connector security policies"; sorry about that!
   
   Anyways, TL;DR: As long as we keep the first sentence brief, space shouldn't 
be a concern with these descriptions, and it may be helpful to clarify what 
exactly this package does in the second sentence and beyond to avoid misleading 
users. I've tweaked the suggestion to fix a mistake. LMKWYT



-- 
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