You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2021/11/17 11:29:56 UTC

[GitHub] [druid] petermarshallio opened a new issue #11936: Docs - tuningConfig options can be simplified

petermarshallio opened a new issue #11936:
URL: https://github.com/apache/druid/issues/11936


   **In documentation, `tuningConfig` configuration options are split into different ingestion task types, introducing potential hops between pages, and potentially conflicting information unless the user knows what ingestion type they are looking at.**
   
   ## Affected Version
   
   0.22.0
   
   ## Description
   
   - `tuningConfig` documentation is split across five pages:
   
   https://druid.apache.org/docs/latest/ingestion/ingestion-spec.html#tuningconfig
   https://druid.apache.org/docs/latest/ingestion/native-batch.html#tuningconfig
   https://druid.apache.org/docs/latest/development/extensions-core/kafka-ingestion.html#kafkasupervisortuningconfig
   https://druid.apache.org/docs/latest/development/extensions-core/kinesis-ingestion.html#tuningconfig
    
   - `kafka` options are a subset of those for `kinesis` - 22 are common, with 8 unique to kinesis
   - When `hadoop` is taken out of the equation, the number of config options that are common to all ingestion types jumps from 3 to 9
   
   ## Proposal
   
   Based on the presumption that learners are interested in tuning options specific to their own ingestion source systems:
   
   1. New "Ingestion tuning" section after "Ingestion spec"
   2. Batch page begins with link to Hadoop `tuningConfig` section and continues with the 18 `index_parallel`-only options
   3. Streaming page begins with all 22 common options and has a final section for the 8 unique Kinesis options
   4. Refine the config options according to their functional effect with common headings across the batch and streaming pages.


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


[GitHub] [druid] petermarshallio commented on issue #11936: Docs - tuningConfig options can be simplified

Posted by GitBox <gi...@apache.org>.
petermarshallio commented on issue #11936:
URL: https://github.com/apache/druid/issues/11936#issuecomment-971489566


   @techdocsmith how do you feel about this?


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