pnowojski commented on code in PR #23845:
URL: https://github.com/apache/flink/pull/23845#discussion_r1418813358


##########
docs/content/docs/deployment/config.md:
##########
@@ -289,6 +289,15 @@ Enabling RocksDB's native metrics may cause degraded 
performance and should be s
 ----
 ----
 
+# Traces

Review Comment:
   I've clicked through quite a lot of pages, and I didn't find anything too 
concerning or broken. One can argue that the extra level of indentation on most 
pages slightly reduces readability, as ToC takes more space or is more cramped, 
but that's in an exchange of showing the title in the ToC. I think that's a 
fair trade.
   
   And in those pages that have multiple headers lvl 1 ToC obviously is much 
much better. 
   
   I would propose to change to `startLevel = 1.
   
   A couple of examples:
   <img width="1206" alt="Screenshot 2023-12-07 at 10 57 37" 
src="https://github.com/apache/flink/assets/8957547/0cd971b8-df58-4b9f-a625-9c262d9d8ec6";>
   <img width="1245" alt="Screenshot 2023-12-07 at 12 33 53" 
src="https://github.com/apache/flink/assets/8957547/c694dc3d-2104-4eac-bb02-925bb4a196d8";>
   <img width="1193" alt="Screenshot 2023-12-07 at 12 34 45" 
src="https://github.com/apache/flink/assets/8957547/f347bc00-9fa0-4b09-8137-3b768794de37";>
   



-- 
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: issues-unsubscr...@flink.apache.org

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

Reply via email to