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). > The pages are still in staging mode but should be online and running Tue, Ok, tell me if you need help for the publication process. -- Olivier http://twitter.com/ogrisel - http://github.com/ogrisel
