astubbs commented on pull request #11404:
URL: https://github.com/apache/kafka/pull/11404#issuecomment-948399673


   > @astubbs There is a TOC at the top of the page... Not sure what else we 
could do?
   
   Yeah, but for such _critical_ settings, it's way too subtle. People don't 
read carefully entire TOCs. Two options (not that I'm a doc designer or 
anything) - perhaps 
   a) but a `WARNING:: please note read section blah blah` at the top - like an 
[asciidoc 
admonitions](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#admonitions)
   b) actually move the section to be the first section, as it's far more 
important to read than _anything_ else on that page - for example, if you 
forget to put an app id your app will crash immediately, bu the resiliency 
settings are not obvious until you have yourself a sev1 in prod.


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


Reply via email to