[GitHub] [druid] kfaraz commented on a diff in pull request #14225: Clarify compaction docs.

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

kfaraz commented on code in PR #14225:
URL: https://github.com/apache/druid/pull/14225#discussion_r1188127763


##########
docs/data-management/automatic-compaction.md:
##########
@@ -116,10 +116,10 @@ The following properties are automatically set by the Coordinator:
 * `context`: Set according to the user-provided `taskContext`.
 
 Compaction tasks fetch all [relevant segments](compaction.md#compaction-io-configuration) prior to launching any subtasks,
-_unless_ the following items are all set. It is strongly recommended to set all of these items to maximize performance
-and minimize disk usage of the `compact` tasks launched by auto-compaction:
+_unless_ the following items are all set. It is strongly recommended to set all of these items to non-null values to

Review Comment:
   Maybe use the word `field` instead of `item`.



##########
docs/data-management/automatic-compaction.md:
##########
@@ -116,10 +116,10 @@ The following properties are automatically set by the Coordinator:
 * `context`: Set according to the user-provided `taskContext`.
 
 Compaction tasks fetch all [relevant segments](compaction.md#compaction-io-configuration) prior to launching any subtasks,

Review Comment:
   ```suggestion
   Compaction tasks typically fetch all [relevant segments](compaction.md#compaction-io-configuration) prior to launching any subtasks,
   ```



##########
docs/data-management/automatic-compaction.md:
##########
@@ -116,10 +116,10 @@ The following properties are automatically set by the Coordinator:
 * `context`: Set according to the user-provided `taskContext`.
 
 Compaction tasks fetch all [relevant segments](compaction.md#compaction-io-configuration) prior to launching any subtasks,
-_unless_ the following items are all set. It is strongly recommended to set all of these items to maximize performance
-and minimize disk usage of the `compact` tasks launched by auto-compaction:
+_unless_ the following items are all set. It is strongly recommended to set all of these items to non-null values to
+maximize performance and minimize disk usage of the `compact` tasks launched by auto-compaction:
 
-- [`granularitySpec`](compaction.md#compaction-granularity-spec). All three values must be set to non-null values: `segmentGranularity`, `queryGranularity`, and `rollup`.
+- [`granularitySpec`](compaction.md#compaction-granularity-spec), including all three of `segmentGranularity`, `queryGranularity`, and `rollup`

Review Comment:
   Slight rephrase:
   ```suggestion
   - [`granularitySpec`](compaction.md#compaction-granularity-spec), with non-null values for each of `segmentGranularity`, `queryGranularity`, and `rollup`.
   ```



##########
docs/data-management/automatic-compaction.md:
##########
@@ -116,10 +116,10 @@ The following properties are automatically set by the Coordinator:
 * `context`: Set according to the user-provided `taskContext`.
 
 Compaction tasks fetch all [relevant segments](compaction.md#compaction-io-configuration) prior to launching any subtasks,
-_unless_ the following items are all set. It is strongly recommended to set all of these items to maximize performance
-and minimize disk usage of the `compact` tasks launched by auto-compaction:
+_unless_ the following items are all set. It is strongly recommended to set all of these items to non-null values to

Review Comment:
   ```suggestion
   _unless_ the following fields are all set to non-null values. It is strongly recommended to set these fields to 
   ```



-- 
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: commits-unsubscribe@druid.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org