On 7 July 2011 07:17, Jasha Joachimsthal <[email protected]> wrote: > With RAVE-45 (Non localhost support) we have a feature that goes beyond > "unzip the binary distribution and run Tomcat". Such features need > documentation how to configure / extend / customize the default setup. > Where should we document this? "The code is the documentation" or "have a > look at the test case" is not what users like. Should we place documentation > on the website or on a wiki?
In my opinion the website should be the main source of documentation I say this for a couple of reasons. a) it's editable offline thanks to the SVN back-end b) non-commetters can easily provide a patch c) it's hard (impossible?) to spam it d) the mdtext source is meaningful as text in most cases e) an offline rendering of it can be generated for distribution > If it's going to be the website, how can we > maintain an increasing set of features to be documented without creating a > large menu on the left hand side (e.g. oAuth, custom databases, login > mechanisms, skinning)? The documentation system is built on a templating system. You can create a documentation section of the website where the template for the navigation on the left is contextualised to the page in question. As a simple example you could have: Top Level Navigation ----------------------------- About Contributing Documentation ... Contributing Navigation --------------------------------- Home Reporting Bugs Requesting Features Submitting patches .... Documentation Navigation ------------------------------------- Home Installing Feature Walktrhough Configuration Options Deploying widgets ....
