[GitHub] [kafka] guozhangwang commented on a diff in pull request #13082: MINOR: Clarify docs for Streams config max.warmup.replicas.

["guozhangwang (via GitHub)" <gi...@apache.org>]

guozhangwang commented on code in PR #13082:
URL: https://github.com/apache/kafka/pull/13082#discussion_r1106267030


##########
docs/streams/developer-guide/config-streams.html:
##########
@@ -778,10 +778,20 @@ <h4><a class="toc-backref" href="#id34">rack.aware.assignment.tags</a><a class="
           <span id="streams-developer-guide-max-warmup-replicas"></span><h4><a class="toc-backref" href="#id29">max.warmup.replicas</a><a class="headerlink" href="#max-warmup-replicas" title="Permalink to this headline"></a></h4>
           <blockquote>
             <div>
-              The maximum number of warmup replicas (extra standbys beyond the configured num.standbys) that can be assigned at once for the purpose of keeping
-              the task available on one instance while it is warming up on another instance it has been reassigned to. Used to throttle how much extra broker
-              traffic and cluster state can be used for high availability. Increasing this will allow Streams to warm up more tasks at once, speeding up the time
-              for the reassigned warmups to restore sufficient state for them to be transitioned to active tasks. Must be at least 1.
+              <p>
+                The maximum number of warmup replicas (extra standbys beyond the configured <code class="docutils literal"><span class="pre">num.standbys</span></code>) that can be assigned at once for the purpose of keeping
+                the task available on one instance while it is warming up on another instance it has been reassigned to. Used to throttle how much extra broker
+                traffic and cluster state can be used for high availability. Increasing this will allow Streams to warm up more tasks at once, speeding up the time
+                for the reassigned warmups to restore sufficient state for them to be transitioned to active tasks. Must be at least 1.
+              </p>
+              <p>
+                Note that one warmup replica corresponds to one Stream Task. Furthermore, note that each warmup task can only be promoted to an active task during

Review Comment:
   Could we add a cf for any capitalized terms and concepts like Stream Task here as well? The link would be: https://kafka.apache.org/34/documentation/streams/architecture#streams_architecture_tasks



-- 
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-unsubscribe@kafka.apache.org

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