gianm commented on code in PR #14866:
URL: https://github.com/apache/druid/pull/14866#discussion_r1303301058


##########
docs/configuration/index.md:
##########
@@ -2026,8 +2026,8 @@ You can optionally only configure caching to be enabled 
on the Broker by setting
 See [cache configuration](#cache-configuration) for how to configure cache 
settings.
 
 :::info
- Note: Even if cache is enabled, for [groupBy 
v2](../querying/groupbyquery.md#strategies) queries, segment level cache do not 
work on Brokers.
- See [Differences between v1 and 
v2](../querying/groupbyquery.md#differences-between-v1-and-v2) and [Query 
caching](../querying/caching.md) for more information.
+ Note: Even if cache is enabled, for [groupBy](../querying/groupbyquery.md) 
queries, segment level cache does not work on Brokers.
+ See [query caching](../querying/caching.md) for more information.

Review Comment:
   IMO @ektravel's perspective makes sense. If the link text is a title of a 
page and is referring to the page itself then capitalizing the first letter 
seems good. It emphasizes that we're referring to a documentation page rather 
than a concept.
   
   To me this is correct (the text refers to the page being linked to):
   
   ```
   See [Query caching](../querying/caching.md) for more information.
   ```
   
   And this is also correct (the text refers to a concept, not the page being 
linked to):
   
   ```
   It is important to set up [query caching](../querying/caching.md) properly 
for best performance.
   ```
   
   Btw, the following is also IMO correct, but awkward and I'd avoid it in 
favor of the first example. Here "query caching" is a common noun acting as an 
adjective for "documentation"; it's not referring to the page being linked to, 
so it shouldn't be capitalized:
   
   ```
   See the [query caching](../querying/caching.md) documentation for more 
information.
   ```



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to