+1 to relying heavily on the wiki for #1 and #2. Cheers, Chris
On 3/21/13 5:52 AM, "Kevin Minder" <[email protected]> wrote: >Hi Everyone, > >Thanks to prodding from Chris we have our wiki setup >https://cwiki.apache.org/confluence/display/KNOX/Index > >With that in place we need to start thinking about what goes in the wiki. >Specifically what to put in the wiki vs what is in git and published to >the site via svn. > >Lets take two specific cases. > >1) Release process doc >http://knox.incubator.apache.org/release-process.html >This is the beginnings of the release processes documentation. >Right now it lives in the source >gateway-site/src/site/markdown/release-process.md >This file needs to evolve independently of a given release so my >suggestion would be to have this type of doc in the wiki. > >2) Getting started doc >http://knox.incubator.apache.org/getting-started.html >gateway-site/src/site/markdown/getting-started.md.vm >This file will be fairly dependent on a specific release. As such my >early inclination was to source this from the git repo. >However as I've been experimenting in the RM role I realized that having >docs in git might make cause thrashing late in release cycles. >I don't think we would want a doc "tweak" to invalidate an RC and >require the generation/testing of a new one. > >So I'm proposing that we rely pretty heavily on the wiki for >documentation and the site just links to it. > >Kevin.
