docs/ are generated docs.You might need to modify the files under src/docs/src/documentation/content/xdocs/ See:https://github.com/apache/zookeeper/tree/53b5aaf3cc942706c64e6d271ebbd76d7e5f7428/src/docs/src/documentation/content/xdocs
- Hongchao Deng > Date: Sun, 25 Jan 2015 20:29:00 -0600 > Subject: Questions about my first contribution to ZK > From: [email protected] > To: [email protected] > > Hi, > > So since I'm a few weeks out from starting on building a largish Mesos / > Aurora cluster, I figured it made sense to read the ZK docs. I read through > all of the documentation linked on the homepages that exists under docs/ in > the source tree and found a decent number of tyops or grammatical errors. > I've fixed them and would like to contribute it back: > > $ svn diff | diffstat > recipes.xml | 2 +- > releasenotes.xml | 2 +- > zookeeperAdmin.xml | 2 +- > zookeeperInternals.xml | 2 +- > zookeeperObservers.xml | 2 +- > zookeeperOver.xml | 10 +++++----- > zookeeperTutorial.xml | 6 +++--- > 7 files changed, 13 insertions(+), 13 deletions(-) > > I noticed that the actual source is under src/docs/documentation... and the > rendered docs, both html and pdf, are under docs. So... As part of my > contribution to update the source xml docs, do you expect me to send the > rendered html and pdf files along with the same patch? > > Coming from projects like graphite[1] or salt[2], both of which I'm a > co-maintainer of, we only keep the actual source documents in version > control and have post-commit hooks build / render the documentation > artifacts. > > [1] https://github.com/graphite-project - > http://graphite.readthedocs.org/en/latest > [2] https://github.com/saltstack/salt - > http://salt.readthedocs.org/en/latest > > > -- > Jeff Schroeder > > Don't drink and derive, alcohol and analysis don't mix. > http://www.digitalprognosis.com
