cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Reinhard Poetz <reinh...@apache.org>
Subject Re: Status new Cocoon documentation
Date Tue, 15 Feb 2005 17:45:19 GMT
Upayavira wrote:
> David Crossley wrote:
> 
>> Upayavira wrote:
>>
>>> David Crossley wrote:
>>>
>>>> Here is one thing that i cannot grasp yet:
>>>> How will the automatically generated "Sitemap Component Documentation"
>>>> (i.e. the old /userdocs/) fit in with these static repositories?
>>>> Currently we need to run 'build docs' to prepare them, then do 
>>>> 'forrest'.
>>>> http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html
>>>
>>>
>>> How is it done now on Brutus? Isn't there a hook within Forrest to 
>>> call Cocoon's "build docs" before building the site? That way, the 
>>> automatic enhancement of the docs is always done on top of whatever 
>>> is in the new repository, much as it is now.
>>>
>>> Have I missed something?
>>
>>
>>
>> That is correct - the forrestbot is doing what you say.
>>
>> At the moment i have a wrapper shell script that first does an svn update
>> of Cocoon's java sources and core blocks, calls 'build docs', then the
>> forrestbot takes over. That works but is cumbersome.
>>
>> Evidently forrestbot itself could call Cocoon's 'docs' ant target prior
>> to starting. I am working during spare time to get that happening,
>> as there are various glitches.
>>
>> The trouble that i have with the new documentation proposal is that
>> docs sources are moving to another part of the repository, so how
>> will 'build docs' be able to access them? I suppose that assumed default
>> relative pathnames with lots of dot-dots.
> 
> 
> A different part of the repository? Well, they'll according to the 
> proposal, they'll soon be moving back into where they have always been 
> in trunk (src/documentation). So I don't see what the problem is there.

I think so too. After understanding now how it works, there shouldn't be any 
problems as we can use the same behaviour in the future.

> 
> Maybe you're referring to block documentation (for which there actually 
> isn't any at the moment). This I guess would need to be dot-dots back to 
> a checkout of the blocks repository or repositories - or more likely 
> each block would have its own forrestbot setup (assuming that isn't too 
> complex).

If a block has its own docs repository (I will setup one for the Portal block) 
it should also be built by forrestbot.

David, do you have any further questions about "auto-docs"?

-- 
Reinhard Pötz           Independant Consultant, Trainer & (IT)-Coach 

{Software Engineering, Open Source, Web Applications, Apache Cocoon}

                                        web(log): http://www.poetz.cc
--------------------------------------------------------------------

Mime
View raw message