Could we move to git from svn so we can have the docs in the patch with the code too, easier to review and commit and work on for contribs also? To start we could do something easy like create a new directory /site cp -r from svn and then when we release cp -r /site/* svn/site and commit for the release push to the website... or something.
~ Joe Stein - - - - - - - - - - - - - - - - - http://www.stealth.ly - - - - - - - - - - - - - - - - - On Thu, Mar 26, 2015 at 9:27 PM, Jun Rao <j...@confluent.io> 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 >
