Github user hmcl commented on a diff in the pull request:
https://github.com/apache/storm/pull/2637#discussion_r185167619
--- Diff: docs/storm-kafka-client.md ---
@@ -313,4 +313,37 @@ KafkaSpoutConfig<String, String> kafkaConf =
KafkaSpoutConfig
.setTupleTrackingEnforced(true)
```
-Note: This setting has no effect with AT_LEAST_ONCE processing guarantee,
where tuple tracking is required and therefore always enabled.
\ No newline at end of file
+Note: This setting has no effect with AT_LEAST_ONCE processing guarantee,
where tuple tracking is required and therefore always enabled.
+
+# Migrating a `storm-kafka` spout to use `storm-kafka-client`
+
+This may not be an exhaustive list because the `storm-kafka` configs were
taken from Storm 0.9.6
+[SpoutConfig](https://github.com/apache/storm/blob/v0.9.6/external/storm-kafka/src/jvm/storm/kafka/SpoutConfig.java)
and
+[KafkaConfig](https://github.com/apache/storm/blob/v0.9.6/external/storm-kafka/src/jvm/storm/kafka/KafkaConfig.java).
+`storm-kafka-client` spout configurations were taken from Storm 1.0.6
+[KafkaSpoutConfig](https://github.com/apache/storm/blob/v1.0.6/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/KafkaSpoutConfig.java).
+
+| Storm-0.9.6 SpoutConfig | Storm-1.0.6 KafkaSpoutConfig name |
KafkaSpoutConfig usage help |
--- End diff --
The storm version is already specified above and could be omitted in the
table. IF possible I would suggest to present the table such as:
```
| SpoutConfig | KafkaSpoutConfig |
---------------------------------------------------
| prop | desc | default | prop | desc | default |
```
---
