write documentation for new scarab release

Hi 
all,

I have the question, when it is recommended to write some
documentation 
for scarab. Now, or near before the next release? (In my
case I mean the 
default report for example.) I looked into the docs and saw,
that only 
adding some text is not possible in all cases, and some
sections have to 
be overworked on the whole.

cheers
Johannes

------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org

Johannes Hoechstaedter wrote:

>I have the question, when it is recommended to write
some documentation 
>for scarab. Now, or near before the next release? (In my
case I mean the 
>default report for example.) I looked into the docs and
saw, that only 
>adding some text is not possible in all cases, and some
sections have to 
>be overworked on the whole.

IMO ideally we should update the documentation as we develop
a new feature.
So just go ahead and submit a patch.

However, let's hear what Jean-François has to say. He is the
creator of most of the current documentation.

Ronny





------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org

If you drop any chunk of interesting documentation to the
dev list, with 
a hint that it should be included in the current doc, and if
possible 
where, I''ll be happy to care for the rest !!
(polish if necessary, format in DocBook/Xml, regenerate,
republish).

Völker Ronny a écrit :
> Johannes Hoechstaedter wrote:
>
>   
>> I have the question, when it is recommended to
write some documentation 
>> for scarab. Now, or near before the next release?
(In my case I mean the 
>> default report for example.) I looked into the docs
and saw, that only 
>> adding some text is not possible in all cases, and
some sections have to 
>> be overworked on the whole.
>>     
>
> IMO ideally we should update the documentation as we
develop a new feature.
> So just go ahead and submit a patch.
>
> However, let's hear what Jean-François has to say. He
is the creator of most of the current documentation.
>
> Ronny
>   


------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org

ok,

I would like to submit a patch for the docu files. In which
way pictures 
(screenshots) are handled?

cheers

Jean-François El Fouly schrieb:
> If you drop any chunk of interesting documentation to
the dev list, 
> with a hint that it should be included in the current
doc, and if 
> possible where, I''ll be happy to care for the rest !!
> (polish if necessary, format in DocBook/Xml,
regenerate, republish).
>
> Völker Ronny a écrit :
>> Johannes Hoechstaedter wrote:
>>
>>  
>>> I have the question, when it is recommended to
write some 
>>> documentation for scarab. Now, or near before
the next release? (In 
>>> my case I mean the default report for example.)
I looked into the 
>>> docs and saw, that only adding some text is not
possible in all 
>>> cases, and some sections have to be overworked
on the whole.
>>>     
>>
>> IMO ideally we should update the documentation as
we develop a new 
>> feature.
>> So just go ahead and submit a patch.
>>
>> However, let's hear what Jean-François has to say.
He is the creator 
>> of most of the current documentation.
>>
>> Ronny
>>   
>
>
>
------------------------------------------------------------
---------
> To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
> For additional commands, e-mail: dev-helpscarab.tigris.org
>
>
>

------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org

Johannes Hoechstaedter a écrit :
> ok,
>
> I would like to submit a patch for the docu files. In
which way 
> pictures (screenshots) are handled?
>
> cheers
Since I need to have several screenshots for the different
languages 
(well, at least for en and fr) when possible, if the
explanation is 
clear enough I'll do/redo them anyway so... normal
screenshots to show 
what you intend to explain ?

------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org

I need screenshots which are more up to date, and show the
new features. 
I only want to replace the old ones.

Jean-François El Fouly schrieb:
> Johannes Hoechstaedter a écrit :
>> ok,
>>
>> I would like to submit a patch for the docu files.
In which way 
>> pictures (screenshots) are handled?
>>
>> cheers
> Since I need to have several screenshots for the
different languages 
> (well, at least for en and fr) when possible, if the
explanation is 
> clear enough I'll do/redo them anyway so... normal
screenshots to show 
> what you intend to explain ?
>
>
------------------------------------------------------------
---------
> To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
> For additional commands, e-mail: dev-helpscarab.tigris.org
>
>
>

------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org

Johannes Hoechstaedter a écrit :
> I need screenshots which are more up to date, and show
the new 
> features. I only want to replace the old ones.
>
No problem, just tell me where/what you want.
Tell what's out of date and I'll make new ones in EN and
FR.
At this moment may take a few days because I need a fresh
setup of 
Scarab HEAD.


------------------------------------------------------------
---------
To unsubscribe, e-mail: dev-unsubscribescarab.tigris.org
For additional commands, e-mail: dev-helpscarab.tigris.org