jihoonson commented on a change in pull request #9804:
URL: https://github.com/apache/druid/pull/9804#discussion_r420463741
##########
File path: docs/development/extensions-core/kafka-ingestion.md
##########
@@ -122,9 +122,9 @@ A sample supervisor spec is shown below:
|Field|Description|Required|
|--------|-----------|---------|
|`type`|The supervisor type, this should always be `kafka`.|yes|
-|`dataSchema`|The schema that will be used by the Kafka indexing task during
ingestion, see [`dataSchema`](../../ingestion/index.md#dataschema) for
details.|yes|
-|`ioConfig`|A KafkaSupervisorIOConfig to configure the supervisor and indexing
tasks, see below.|yes|
-|`tuningConfig`|A KafkaSupervisorTuningConfig to configure the supervisor and
indexing tasks, see below.|no|
+|`dataSchema`|The schema that will be used by the Kafka indexing task during
ingestion. See [`dataSchema`](../../ingestion/index.md#dataschema) for
details.|yes|
+|`tuningConfig`|A KafkaSupervisorTuningConfig object for configuring
performance-related settings for the supervisor and indexing tasks. See
[KafkaSupervisorTuningConfig](#kafkasupervisortuningconfig) below.|no|
+|`ioConfig`|A KafkaSupervisorIOConfig object for configuring Kafka connection
and I/O-related settings for the supervisor and indexing task. See
[KafkaSupervisorIOConfig](#kafkasupervisorioconfig) below.|yes|
Review comment:
I agree that consistency is more important than the order of those
properties and it's not a blanket rule. My concern is mostly about that the
section explaining `tuningConfig` is fairly long in the link above, so you
should scroll down half of the page until you see `ioConfig`. This could be
cumbersome for people who just started using Druid because they wouldn't
understand what most of them mean in the tuningConfig. What do you think?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
