IMHO having your documentation editable and living in a repository is much more manageable than via an external wiki. It enables someone to both make changes to some code/interface AND make changes to the documentation in the same commit! By encouraging this as well we can keep our documentation much more up to date than if it were to live in a separate place. The other nice property of storing documentation in the repository is that we can "freeze" it with releases so that people can get accurate documentation for whatever version they are working with (without lots of noise in the documentation).
If the project wasn't mirrored at github.com/apache/mesos then I'd suggest changing the format of the documentation, but since we should just be able to point people to the documentation nicely rendered in github, it seems like a straightforward first step. On Tue, Feb 26, 2013 at 4:40 PM, Adam Monsen <[email protected]> wrote: > Hi Ben, > > Thanks for your reply. > > On 02/26/2013 02:18 PM, Benjamin Hindman wrote: > > 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). > > So you're saying content at https://github.com/mesos/mesos/wiki should > be committed to source control? > > Or should I just do https://issues.apache.org/jira/browse/MESOS-69 first > and migrate https://github.com/mesos/mesos/wiki to an Apache wiki? > >
