On Jul 3, 2011, at 12:12 PM, Fabian Christ wrote: > Hi, > > 2011/7/3 Olivier Grisel <[email protected]>: >> 2011/6/30 Andreas Gruber <[email protected]>: >>> Dear colleages, >>> >>> I've started with a Apache Stanbol documentation by putting together >>> existing material. >>> >>> The index page [1] shows the installation process and should provide links >>> to concrete usage scenarios, such as content enhancement (should describe >>> user process) as well as to the technical documentation of each >>> component/service (should describe REST API, technical features, >>> configuration etc.) >>> >>> To avoid double work, we should define the "border" between the >>> Documentation and various Readme files and/or think of links between such >>> content. So I am not sure, whether to better describe each engine in detail >>> in the documentation or in the Readme.file directly in the sourcecode? >> >> I am +1 for putting most of the documentation on the website and only >> basic build / configuration / launch instructions + pointer to the >> website in the README files, where applicable (especially the top >> level). > > Yes, that sounds reasonable.
Yes, but is it "the Apache Way" ? Just kidding :) +1. (That's the Nuxeo Way by the way.) S. -- Stefane Fermigier, Founder and Chairman, Nuxeo Open Source, Java EE based, Enterprise Content Management (ECM) http://www.nuxeo.com/ - +33 1 40 33 79 87 - http://twitter.com/sfermigier Join the Nuxeo Group on LinkedIn: http://linkedin.com/groups?gid=43314 New Nuxeo release: http://nuxeo.com/dm54 "There's no such thing as can't. You always have a choice."
