Hi, Everyone,

Quite a few jiras these days require documentation changes (e.g., wire
protocol, ZK layout, configs, jmx, etc). Historically, we have been
updating the documentation just before we do a release. The issue is that
some of the changes will be missed since they were done a while back.
Another way to do that is to keep the docs updated as we complete each
jira. Currently, our documentations are in the following places.

wire protocol:
https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol
ZK layout:
https://cwiki.apache.org/confluence/display/KAFKA/Kafka+data+structures+in+Zookeeper
configs/jmx: https://svn.apache.org/repos/asf/kafka/site/083

We probably don't need to update configs already ported to ConfigDef since
they can be generated automatically. However, for the rest of the doc
related changes, keeping they updated per jira seems a better approach.
What do people think?

Thanks,

Jun

Reply via email to