+1
On Tue, Mar 31, 2015 at 9:23 AM, Jay Kreps <jay.kr...@gmail.com> wrote: > Yeah the protocol should probably move off the wiki and into the > release-versioned docs. > > -Jay > > On Mon, Mar 30, 2015 at 5:17 PM, Joel Koshy <jjkosh...@gmail.com> wrote: > >> Also for the wikis - those should probably correspond to the latest >> released version right? So for e.g., if we add or modify the protocol >> on trunk we can add it to the wiki but mark it with some highlight or >> similar just to make it clear that it is a change on trunk only. >> >> Thanks, >> >> Joel >> >> On Thu, Mar 26, 2015 at 06:27:25PM -0700, Jun Rao wrote: >> > 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 >> >>
