ableegoldman commented on code in PR #18087:
URL: https://github.com/apache/kafka/pull/18087#discussion_r1879254935
##########
docs/streams/developer-guide/config-streams.html:
##########
@@ -231,9 +231,9 @@ <h4><a class="toc-backref"
href="#id23">num.standby.replicas</a><a class="header
<p>Here are the optional <a
href="/{{version}}/javadoc/org/apache/kafka/streams/StreamsConfig.html">Streams</a>
javadocs, sorted by level of importance:</p>
<blockquote>
<div><ul class="simple">
- <li>High: These parameters can have a significant impact on
performance. Take care when deciding the values of these parameters.</li>
- <li>Medium: These parameters can have some impact on performance.
Your specific environment will determine how much tuning effort should be
focused on these parameters.</li>
- <li>Low: These parameters have a less general or less significant
impact on performance.</li>
+ <li>High: These are parameters with default value which are most
likely not a good fit for production use. It's highly recommended to revisit
these parameters for production usage.</li>
+ <li>Medium: The default values of these parameters should work for
production for many cases, but it's not uncommon that they are changed, for
example to tune performance.</li>
+ <li>Low: It should be rarely necessary to change the default for
these parameters. It's only recommended to change them if there is a very
specific issue you want to address.</li>
Review Comment:
```suggestion
<li>Low: It should rarely be necessary to change the value for
these parameters. It's only recommended to change them if there is a very
specific issue you want to address.</li>
```
##########
docs/streams/developer-guide/config-streams.html:
##########
@@ -231,9 +231,9 @@ <h4><a class="toc-backref"
href="#id23">num.standby.replicas</a><a class="header
<p>Here are the optional <a
href="/{{version}}/javadoc/org/apache/kafka/streams/StreamsConfig.html">Streams</a>
javadocs, sorted by level of importance:</p>
<blockquote>
<div><ul class="simple">
- <li>High: These parameters can have a significant impact on
performance. Take care when deciding the values of these parameters.</li>
- <li>Medium: These parameters can have some impact on performance.
Your specific environment will determine how much tuning effort should be
focused on these parameters.</li>
- <li>Low: These parameters have a less general or less significant
impact on performance.</li>
+ <li>High: These are parameters with default value which are most
likely not a good fit for production use. It's highly recommended to revisit
these parameters for production usage.</li>
Review Comment:
nit: grammar
```suggestion
<li>High: These are parameters with a default value which is
most likely not a good fit for production use. It's highly recommended to
revisit these parameters for production usage.</li>
```
--
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
