Folks, I'm working on a proposal for a better audience / goal oriented documentation that takes into account the goals of the different audiences of consumers as well as contributors to the documentation.
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=122916415 At the bottom of the page I'm starting to take inventory of the things internal/external to the Apache Cassandra docs that are out there. My initial notes on documentation that is part of the code tree are to expose that it's a f#$ing bitch to work on the website / documentation for any reason. I understand the need to have a basic threshold to not have rando's committing code, but to require a successful build of cassandra via ant for all downstream artifacts for Sphix / Jekyll is a bit overkill. The website should be the easiest thing for people to work on. Most of the documentation should be easy as well. Not all documentation has a 1-1 correlation to code. The Website and Documentation are sibling artifacts in my opinion, but the website shouldn't have a hard dependency on the core binaries. Ideally, someone who's focused on the use-cases of Cassandra can quickly get into the docs and contribute without having to go through hoops and hurdles (even with Docker compose in the trunk, messing with the JDK version, and then finally commenting out the gen-nodetool command) to move forward. For example, a decouple doc process could help us get doc updates out quicker and smoother with stage sites on gh-pages or otherwise. Best, rahul.xavier.si...@gmail.com http://cassandra.link
