+1 for one source of truth, the repo. wiki could be read-only and/or a place where the docs are rendered.
On Fri, Jun 14, 2013 at 11:26 AM, Dave Lester <[email protected]>wrote: > On Thu, Jun 13, 2013 at 7:29 PM, Mattmann, Chris A (398J) < > [email protected]> wrote: > > > I would just do both. Let contributions and time > > decide; rather than just picking one. > > > I disagree. In this case I see two distinct concerns related to > documentation and the wiki: 1) making it clear and simple for how to > contribute to the project documentation, and 2) making it easy to use the > documentation and get started with Mesos. > > I personally think the latter concern much more pressing for user growth at > this time, although I do think both are important to consider. Do others > think the former is more important? > > As a developer who is getting starting with Mesos, having multiple sources > of truth for the project (documentation stored in git, and also the wiki) > could be frustrating. There's no search between the docs and wiki, and I'm > not clear if there is a distinction between where I would go to answer > specific questions. When contributing documentation, I'm also not sure > which source I would contribute to. > > I'm in favor of using just one source. If making it easy to use the > documentation is the priority then I think rendering markdown files is a > fine approach for now. > > Thoughts? > > Best, > Dave >
