Hi, On Sun, Jun 24, 2012 at 3:16 PM, Ralph Goers <[email protected]>wrote:
> I guess I've embedded the discussion on the web site in with this > discussion and the OOM issues because how the documentation is generated is > related to how it is displayed on the web site and the problems the build > was/is having. > > I am very tempted to go ahead and create a Sphinx-baesd web site starting > with what you've already done, but I don't want to waste my time if that > isn't what is wanted. If I did this it would be built by the CMS system and > therefore would reside in something like > https://svn.apache.org/repos/asf/flume/site/cms/trunk instead of the main > source trunk. My +1 and thanks for doing this. The website needs to be updated and manageable so if you have the necessary cycles, then please do go ahead with it. Currently the site lives in [1] and uses basic xdoc for structured content. Personally, I have no objections to continue using xdoc or moving to a different tool if you feel would add more value. [1] https://svn.apache.org/repos/asf/incubator/flume/site/ > However, it should be possible to capture the documentation into the > release distribution if that is desired or required. While some projects maintain most up to date documentation on the site, IMO it is better to have versioned documentation that corresponds to the release versions available right at the webstie. Regards, Arvind Prabhakar > > Ralph > > Re: [DISCUSS] documentation formats > > On Jun 24, 2012, at 1:42 PM, Mike Percy wrote: > > > I don't think there has been a discussion of how to build the website. > If that is something you want to work on, you could always start a discuss > thread about it. Sphinx has a ton of theming and format output options. > > > > Regards, > > Mike > > >
