Apache Stanbol documentation

[Alberto Musetti <mu...@cs.unibo.it>]

Hi Andreas,

We began to reorganize the documentation for cms-developers, stanbol/vie-developers and also some material for "end-users" as you suggested. So, I want to know if there is some information in addition to [1].

In Salzburg we also have been asked if it was possible to have a template for the documentation and thus to have a unique model for all components. Do you know if it is created?

Good luck for your next work!

Best,
Alberto


[1] https://issues.apache.org/jira/browse/STANBOL-402

Re: Apache Stanbol documentation

[Alberto Musetti <mu...@cs.unibo.it>]

Hi all,

Is it possible to add the "breadcrumbs" to the document's page?

I was reading some pages of [1] and I got lost after some links. Some pages have a link to the main index in the bottom but in my opinion, it is not enough.

Is there any markdown syntax that automatically allows it?

Best,
Alberto

> [1] http://stanbol.staging.apache.org/stanbol/index.html



Il giorno 14/dic/2011, alle ore 14:04, Andreas Gruber ha scritto:

> Hi Alberto, all devs
> 
> the current (hopefully) improved docu is available at the staging[1]
> server, tough there are still holes in it. I try to improve the
> tutorial section (another tutorial showing the available stable
> RESTful services and cURL calls) and streamline the overal index page,
> and ask the developers to
> 
> a) provide information on the dev to dev documentation (Guidelines,
> Examples how to create an own Engine, ...) and
> 
> b) make shure, that the current description of the components is
> up-to-date and available at the level of README files, within the
> WebUI of the software and at the documentation site.
> 
> I do not have an template for describing the components yet - but IMO
> each of them should contain a short descriptive paragraph, concrete
> examples (cURL) as well as specific configuration abilities.
> 
> If there are no major issues left out, this state should be published
> in the next days.
> 
> Best,
> 
> Andreas
> 
> 
> 
> [1] http://stanbol.staging.apache.org/stanbol/index.html
> 
> On Wed, Dec 14, 2011 at 11:40 AM, Alberto Musetti <mu...@cs.unibo.it> wrote:
>> Hi Andreas,
>> 
>> We began to reorganize the documentation for cms-developers, stanbol/vie-developers and also some material for "end-users" as you suggested. So, I want to know if there is some information in addition to [1].
>> 
>> In Salzburg we also have been asked if it was possible to have a template for the documentation and thus to have a unique model for all components. Do you know if it is created?
>> 
>> Good luck for your next work!
>> 
>> Best,
>> Alberto
>> 
>> 
>> [1] https://issues.apache.org/jira/browse/STANBOL-402

Re: Apache Stanbol documentation

[Andreas Gruber <ag...@apache.org>]

Hi Alberto, all devs

the current (hopefully) improved docu is available at the staging[1]
server, tough there are still holes in it. I try to improve the
tutorial section (another tutorial showing the available stable
RESTful services and cURL calls) and streamline the overal index page,
and ask the developers to

a) provide information on the dev to dev documentation (Guidelines,
Examples how to create an own Engine, ...) and

b) make shure, that the current description of the components is
up-to-date and available at the level of README files, within the
WebUI of the software and at the documentation site.

I do not have an template for describing the components yet - but IMO
each of them should contain a short descriptive paragraph, concrete
examples (cURL) as well as specific configuration abilities.

If there are no major issues left out, this state should be published
in the next days.

Best,

Andreas



[1] http://stanbol.staging.apache.org/stanbol/index.html

On Wed, Dec 14, 2011 at 11:40 AM, Alberto Musetti <mu...@cs.unibo.it> wrote:
> Hi Andreas,
>
> We began to reorganize the documentation for cms-developers, stanbol/vie-developers and also some material for "end-users" as you suggested. So, I want to know if there is some information in addition to [1].
>
> In Salzburg we also have been asked if it was possible to have a template for the documentation and thus to have a unique model for all components. Do you know if it is created?
>
> Good luck for your next work!
>
> Best,
> Alberto
>
>
> [1] https://issues.apache.org/jira/browse/STANBOL-402