kkonstantine commented on a change in pull request #8623:
URL: https://github.com/apache/kafka/pull/8623#discussion_r427036583



##########
File path: docs/connect.html
##########
@@ -129,9 +129,11 @@ <h4><a id="connect_transforms" 
href="#connect_transforms">Transformations</a></h
     <p>The file source connector reads each line as a String. We will wrap 
each line in a Map and then add a second field to identify the origin of the 
event. To do this, we use two transformations:</p>
     <ul>
         <li><b>HoistField</b> to place the input line inside a Map</li>
-        <li><b>InsertField</b> to add the static field. In this example we'll 
indicate that the record came from a file connector</li>

Review comment:
       This is also not correct. 
   This refers to what we say above as: _then add a second field to identify 
the origin of the event_
   So this correctly refers to what will be added in this new field when using 
`InsertField`

##########
File path: docs/security.html
##########
@@ -398,7 +398,7 @@ <h5>Host Name Verification</h5>
             ssl.keystore.password=test1234
             ssl.key.password=test1234</pre>
 
-            Other configuration settings that may also be needed depending on 
our requirements and the broker configuration:
+            Other configuration settings that may also be needed depending on 
requirements and the broker configuration:

Review comment:
       I'm not sure this is redundant. This refers to the user's requirements. 

##########
File path: docs/connect.html
##########
@@ -103,7 +103,7 @@ <h4><a id="connect_configuring" 
href="#connect_configuring">Configuring Connecto
         <li><code>topics.regex</code> - A Java regular expression of topics to 
use as input for this connector</li>
     </ul>
 
-    <p>For any other options, you should consult the documentation for the 
connector.</p>
+    <p>For any other options, you should consult the <a 
href="#connectconfigs">documentation</a> for the connector.</p>

Review comment:
       That's not accurate. The documentation for the connector is not the same 
as the Worker configs. 
   This indeed refers to the docs of each individual connector

##########
File path: docs/ops.html
##########
@@ -477,16 +477,20 @@ <h4><a id="rep-throttle" href="#rep-throttle">Limiting 
Bandwidth Usage during Da
   Throttle was removed.</pre>
 
   <p>The administrator can also validate the assigned configs using the 
kafka-configs.sh. There are two pairs of throttle
-      configuration used to manage the throttling process. The throttle value 
itself. This is configured, at a broker
+      configuration used to manage the throttling process. This is configured, 
at a broker

Review comment:
       This is not redundant. It refers to the two pairs of properties shown 
below.  You can say instead: 
   
   ```suggestion
         configuration used to manage the throttling process. First pair refers 
to the throttle value itself. This is configured, at a broker
   ```
   
   then below you could amend the sentence to say: 
   _There is also an enumerated set of throttled replicas:_ -> _Then there is 
the configuration pair of enumerated set of throttled replicas:_

##########
File path: docs/ops.html
##########
@@ -477,16 +477,20 @@ <h4><a id="rep-throttle" href="#rep-throttle">Limiting 
Bandwidth Usage during Da
   Throttle was removed.</pre>
 
   <p>The administrator can also validate the assigned configs using the 
kafka-configs.sh. There are two pairs of throttle
-      configuration used to manage the throttling process. The throttle value 
itself. This is configured, at a broker
+      configuration used to manage the throttling process. This is configured, 
at a broker
       level, using the dynamic properties: </p>
 
-  <pre class="brush: text;">leader.replication.throttled.rate
-  follower.replication.throttled.rate</pre>
+  <pre class="brush: text;">
+    leader.replication.throttled.rate
+    follower.replication.throttled.rate
+  </pre>
 
   <p>There is also an enumerated set of throttled replicas: </p>

Review comment:
       Then here you could amend the sentence to say:
   ```suggestion
     <p>Then there is the configuration pair of throttled replicas: </p>
   ```

##########
File path: docs/ops.html
##########
@@ -477,16 +477,20 @@ <h4><a id="rep-throttle" href="#rep-throttle">Limiting 
Bandwidth Usage during Da
   Throttle was removed.</pre>
 
   <p>The administrator can also validate the assigned configs using the 
kafka-configs.sh. There are two pairs of throttle
-      configuration used to manage the throttling process. The throttle value 
itself. This is configured, at a broker
+      configuration used to manage the throttling process. This is configured, 
at a broker
       level, using the dynamic properties: </p>
 
-  <pre class="brush: text;">leader.replication.throttled.rate
-  follower.replication.throttled.rate</pre>
+  <pre class="brush: text;">
+    leader.replication.throttled.rate
+    follower.replication.throttled.rate
+  </pre>
 
   <p>There is also an enumerated set of throttled replicas: </p>
 
-  <pre class="brush: text;">leader.replication.throttled.replicas
-  follower.replication.throttled.replicas</pre>
+  <pre class="brush: text;">
+    leader.replication.throttled.replicas
+    follower.replication.throttled.replicas
+  </pre>
 
   <p>Which are configured per topic. All four config values are automatically 
assigned by kafka-reassign-partitions.sh

Review comment:
       Then you can add a break here: 
   
   ```suggestion
     <p>Which are configured per topic.</p> 
     <p> All four config values are automatically assigned by 
kafka-reassign-partitions.sh
   ```




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

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


Reply via email to