Ben, great job pointing this out to Adam. Cheers, Chris
On 2/26/13 2:18 PM, "Benjamin Hindman" <[email protected]> wrote: >Hey Adam! > >I love the enthusiasm on improving Mesos documentation! That being said, >it's probably a bit too early for a book. ;) > >I think it would be great to create a documentation ticket on JIRA so we >can figure out exactly what documentation we want to start creating. IMHO, >a great first step would be to get the old documentation that still lives >at https://github.com/mesos/mesos/wiki into the repository (you can submit >reviews for that). After that we can start editing the documentation >together to get it up to date. I'm not opposed to continuing to use Github >markdown for this (for now), since we can still point people to >github.com/apache/mesos/documenation or something similar in order to >"render" the documentation correctly. That being said, I'd prefer that all >of our actual work is done within the Apache infrastructure (JIRA, Review >Board, etc) to keep things consistent. Seems like we could always port the >documentation over to something else in the future if Apache provides >other >wiki options (note: I know that Confluence wiki exists, but I'm not sure >if >we'd want to go down that route). > >I look forward to any patches that come our way! > >Ben. > > >On Mon, Feb 25, 2013 at 5:03 PM, Adam Monsen <[email protected]> wrote: > >> I've heard several folks mention the need to improve documentation for >> Mesos. I kicked off a little experimental book. There's almost zero >> content so far (and what exists is cut-and-pasted from existing public >> docs), I'm just looking for feedback on my approach. Check it out! >> >> https://github.com/meonkeys/the-mesos-book >> >> Thoughts? >> >> The idea would be to port all existing stable documentation into this >> book. It would become the most complete and best reference for Mesos >> users (perhaps developers, too). Other documentation sources would still >> exist such as in-the-code API docs and fluid/collaborative docs (wiki >> pages). >> >> I went with Pandoc Markdown because I read and enjoyed The Little >> MongoDB Book by Karl Seguin >> (http://openmymind.net/2011/3/28/The-Little-MongoDB-Book/ , >> https://github.com/karlseguin/the-little-mongodb-book ). I've also read >> quite a bit of Scott Chacon's awesome book Pro Git ( http://progit.org , >> https://github.com/progit/progit ), which is similarly written in >> Markdown and processed into other beautiful formats using software >>tools. >> >>
