You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lenya.apache.org by "Gregor J. Rothfuss" <gr...@apache.org> on 2005/05/25 04:02:58 UTC

documentation prototyping with lenya (on the zone)

we now have the means to use lenya (on our zone) to feed our 
documentation. i think we should do some experiments as to how we could 
eat our own dogfood to create the docs for the site.

there are lots of nice bells and whistles, but i would like us to get 
started with something simple and then extend the solution as we use it 
more and more.

as you may have noted elsewhere, this currently a hot topic both on the 
cocoon project, and overall. the asf has resurrected the site-dev list 
to coordinate requirements, and there is a common site-build zone that 
we may end up using for staging and deployment. i have attached one of 
the key emails from that list below.

i am not yet totally clear how this will all work together, but we 
should definitely get started as soon as possible (keeping in mind that 
we now have two community members, solprovider and jon, who regularly 
write useful documentation)

WDYT?

-------- Original Message --------
Subject: mission
Date: Wed, 11 May 2005 00:12:44 +1000
From: David Crossley <cr...@apache.org>
Reply-To: site-dev@apache.org
To: site-dev@apache.org

I suppose that we should first clarify our purpose,
then send an email to pmcs@ asking for people to help
from the beginning and so enable ownership.

There was a recent flurry of discussion on infrastructure@
when Noel suggested we finally have the machinery to establish
a site build and staging server. ...

Noel J. Bergman wrote:
> Justin Erenkrantz wrote:
>
> > I don't see the need for a zone dedicated to creating the apache.org
> > sites.  Why can't each PMC have their own zone and create their
> > site in it however they want to do it?
>
> We need a single place for infrastructure to restore from if we have a
> problem, right?  And we are trying to move away from having to keep huge
> quantities of generated artifacts in source control just for the purpose of
> restoring the web-site.
>
> So the primary goals are:
>
>   - have a means to build all of the web sites from source control
>   - provide for human review of the staged content
>   - push the approved content to a publishing area
>   - have the live web servers sync from the publishing area
>
> So, we reduce the need for shell accounts related to publishing, remove the
> need to keep generated sites in source control, improve disaster recovery.
>
>       --- Noel

This has been discussed many times before on infrastructure.
I tried to summarise some of the needs at one stage.
http://forrest.apache.org/0.7/proposal-asf-publish.html
Here is the first paragraph ...

All ASF projects need to be able to concentrate on their projects
and the content of their websites, rather than get tangled up in
arcane website publication procedures.

I presume that we need a site-build.zones.apache.org
where we would run the various documentation tools, e.g.
Maven, Forrest, Anakia, Ant, etc. There is also the web interface
for the Forrestbot which enables project committers to trigger
their build and review logfiles. It would need Tomcat.

Add to that mechanisms to generate javadoc and other code docs.

Without going into details too much, are those our aims?

--David


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Andreas Hartmann wrote:

> I started such a publication using the Forrest infrastructure
> (sitemaps, modules etc.). The major problem I'm running into is
> the configuration of @project.home@ and @context.home@. The
> ForrestConfModule is not designed to be overridden, as it relies
> on the ForrestConfUtils class and its static methods. I didn't
> want to start a new conf module implementation unless there's no
> other way.

this seems also relevant:

http://mail-archives.apache.org/mod_mbox/forrest-dev/200505.mbox/%3c428DA4F8.7080709@apache.org%3e

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Andreas Hartmann <an...@apache.org>.
Thorsten Scherler wrote:

[...]

>>I think we agreed to create a pub within the sandbox (lenya/sandbox)
>>and call it "doco".

I started such a publication using the Forrest infrastructure
(sitemaps, modules etc.). The major problem I'm running into is
the configuration of @project.home@ and @context.home@. The
ForrestConfModule is not designed to be overridden, as it relies
on the ForrestConfUtils class and its static methods. I didn't
want to start a new conf module implementation unless there's no
other way.

Thorsten, is it possible to configure these settings in another way?

What should be the general policy if incompatiblities occur?
Patching or asking the Forrest community to generalize the code?

-- Andreas


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Michael Wechner wrote:

> right, I totally forgot that Forrest has something similar like the 
> sitetree of the
> default publication, which is kind of "independent" of the actual 
> content hierarchy.

it is only marginally different from sitetree.xml

content still has to be nested in site.xml the same way it is stored on 
the file system. the only difference is that each node's element name 
can be used to refer to a node (if the name is unique). it escapes me 
why the unique name is not the id of the node element, but instead the 
element name, making validation impossible..

> I thought we could just generate it on the fly basically, but yes we 
> would have
> to implement at least the "addNode".

might as well implement the whole interface so we can use the site area 
properly

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Gregor J. Rothfuss wrote:

> Michael Wechner wrote:
>
>> I would suggest that for the moment we just drop the site/info area and
>> focuse on viewing the content, creating new docs, editing docs and 
>> publishing them.
>
>
> that would not help, since forrest requires a valid site.xml to work 
> properly


right, I totally forgot that Forrest has something similar like the 
sitetree of the
default publication, which is kind of "independent" of the actual 
content hierarchy.

I thought we could just generate it on the fly basically, but yes we 
would have
to implement at least the "addNode".

Michi

>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
>
>


-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Michael Wechner wrote:

> I would suggest that for the moment we just drop the site/info area and
> focuse on viewing the content, creating new docs, editing docs and 
> publishing them.

that would not help, since forrest requires a valid site.xml to work 
properly

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Andreas Hartmann wrote:

> Gregor J. Rothfuss wrote:
>
>> Michael Wechner wrote:
>>
>>>> The other question is how can I "teach" lenya the new site 
>>>> structure? I
>>>> mean there is no .../dir/index_en.html in forrest.
>>>
>>
>>
>> 2 parts: documentidtopathmapper, the simple one will be sufficient here
>> and a new implementation of sitetree that is capable of producing 
>> site.xml
>
>
> Maybe they should even be called
>
>   ForrestDocumentIdToPathMapper
>   ForrestSiteManager


I would suggest that for the moment we just drop the site/info area and
focuse on viewing the content, creating new docs, editing docs and 
publishing them.

Michi

>
> which would make their purposes clear.
>
> -- Andreas
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
>
>


-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Andreas Hartmann <an...@apache.org>.
Gregor J. Rothfuss wrote:
> Michael Wechner wrote:
> 
>>> The other question is how can I "teach" lenya the new site structure? I
>>> mean there is no .../dir/index_en.html in forrest.
> 
> 
> 2 parts: documentidtopathmapper, the simple one will be sufficient here
> and a new implementation of sitetree that is capable of producing site.xml

Maybe they should even be called

   ForrestDocumentIdToPathMapper
   ForrestSiteManager

which would make their purposes clear.

-- Andreas


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Michael Wechner wrote:

>> The other question is how can I "teach" lenya the new site structure? I
>> mean there is no .../dir/index_en.html in forrest.

2 parts: documentidtopathmapper, the simple one will be sufficient here
and a new implementation of sitetree that is capable of producing site.xml

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Thorsten Scherler wrote:

>On Mon, 2005-05-30 at 16:18 +0200, Michael Wechner wrote:
>  
>
>>Thorsten Scherler wrote:
>>
>>    
>>
>>>On Thu, 2005-05-26 at 17:49 -0400, Gregor J. Rothfuss wrote:
>>> 
>>>
>>>      
>>>
>>>>Michael Wechner wrote:
>>>>
>>>>   
>>>>
>>>>        
>>>>
>>>>>shall we then start a "xdoc/forrest" publication wihin the sandbox?
>>>>>We might want to call the publication "doco" or "forrest" or "xdoc" or 
>>>>>whatever..
>>>>>     
>>>>>
>>>>>          
>>>>>
>>>>doco
>>>>   
>>>>
>>>>        
>>>>
>>>I started to convert the v20 dtd to relaxNG. Should I create a new pub
>>>in 1.4 and check that in?
>>> 
>>>
>>>      
>>>
>>I think we agreed to create a pub within the sandbox (lenya/sandbox)
>>and call it "doco".
>>    
>>
>
>Yeah, see above. ;-)
>
>How can I then tell lenya to use that pub? 
>A simple ln -s will do I guess but is there another possibility that
>will work as well on a windows box?
>  
>

take a look at local.build.properties ;-)

>The other question is how can I "teach" lenya the new site structure? I
>mean there is no .../dir/index_en.html in forrest.
>

take a look at the blog publication, where you first have to create an  
entry
through the web-interface ...

HTH

Michi

> Do I have to
>implement it in the pub.xmap or is there a better solution to do so?
>
>salu2
>  
>


-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Mon, 2005-05-30 at 16:18 +0200, Michael Wechner wrote:
> Thorsten Scherler wrote:
> 
> >On Thu, 2005-05-26 at 17:49 -0400, Gregor J. Rothfuss wrote:
> >  
> >
> >>Michael Wechner wrote:
> >>
> >>    
> >>
> >>>shall we then start a "xdoc/forrest" publication wihin the sandbox?
> >>>We might want to call the publication "doco" or "forrest" or "xdoc" or 
> >>>whatever..
> >>>      
> >>>
> >>doco
> >>    
> >>
> >
> >I started to convert the v20 dtd to relaxNG. Should I create a new pub
> >in 1.4 and check that in?
> >  
> >
> 
> I think we agreed to create a pub within the sandbox (lenya/sandbox)
> and call it "doco".

Yeah, see above. ;-)

How can I then tell lenya to use that pub? 
A simple ln -s will do I guess but is there another possibility that
will work as well on a windows box?

The other question is how can I "teach" lenya the new site structure? I
mean there is no .../dir/index_en.html in forrest. Do I have to
implement it in the pub.xmap or is there a better solution to do so?

salu2
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Thorsten Scherler wrote:

>On Thu, 2005-05-26 at 17:49 -0400, Gregor J. Rothfuss wrote:
>  
>
>>Michael Wechner wrote:
>>
>>    
>>
>>>shall we then start a "xdoc/forrest" publication wihin the sandbox?
>>>We might want to call the publication "doco" or "forrest" or "xdoc" or 
>>>whatever..
>>>      
>>>
>>doco
>>    
>>
>
>I started to convert the v20 dtd to relaxNG. Should I create a new pub
>in 1.4 and check that in?
>  
>

I think we agreed to create a pub within the sandbox (lenya/sandbox)
and call it "doco".

Michi

>salu2
>  
>


-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Thu, 2005-05-26 at 17:49 -0400, Gregor J. Rothfuss wrote:
> Michael Wechner wrote:
> 
> > shall we then start a "xdoc/forrest" publication wihin the sandbox?
> > We might want to call the publication "doco" or "forrest" or "xdoc" or 
> > whatever..
> 
> doco

I started to convert the v20 dtd to relaxNG. Should I create a new pub
in 1.4 and check that in?

salu2
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Michael Wechner wrote:

> shall we then start a "xdoc/forrest" publication wihin the sandbox?
> We might want to call the publication "doco" or "forrest" or "xdoc" or 
> whatever..

doco

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Thorsten Scherler wrote:

>On Wed, 2005-05-25 at 22:35 +0200, Michael Wechner wrote:
>  
>
>>we could start such a publication within the sandbox and based on 1.4-dev
>>which would hopefully help to stabilize 1.
>>    
>>
>
>+1
>  
>

shall we then start a "xdoc/forrest" publication wihin the sandbox?
We might want to call the publication "doco" or "forrest" or "xdoc" or 
whatever..

Michi

-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Wed, 2005-05-25 at 22:35 +0200, Michael Wechner wrote:
> Gregor J. Rothfuss wrote:
> 
> > we now have the means to use lenya (on our zone) to feed our 
> > documentation. i think we should do some experiments as to how we 
> > could eat our own dogfood to create the docs for the site.
> 
> 
> sure
> 
> >
> > there are lots of nice bells and whistles, but i would like us to get 
> > started with something simple and then extend the solution as we use 
> > it more and more.
> 
> 
> we just have to write a xdoc based publication which has the same 
> site-structure as
> Forrest and then export it statically into SVN, whereas the xdocs should 
> also be added
> to SVN
> 

+1

Would be 
lenya-xdocs-pub (live)->docu-svn (xdocs) [trunk]
lenya.apache.org->Build from docu-svn in site-svn [trunk]

> >
> > as you may have noted elsewhere, this currently a hot topic both on 
> > the cocoon project, and overall. the asf has resurrected the site-dev 
> > list to coordinate requirements, and there is a common site-build zone 
> > that we may end up using for staging and deployment. i have attached 
> > one of the key emails from that list below.
> >
> > i am not yet totally clear how this will all work together, but we 
> > should definitely get started as soon as possible (keeping in mind 
> > that we now have two community members, solprovider and jon, who 
> > regularly write useful documentation)
> >
> > WDYT?
> 
[...]
> we could start such a publication within the sandbox and based on 1.4-dev
> which would hopefully help to stabilize 1.

+1

salu2
thorsten

> Michi
> 
> >
> > -------- Original Message --------
> > Subject: mission
> > Date: Wed, 11 May 2005 00:12:44 +1000
> > From: David Crossley <cr...@apache.org>
> > Reply-To: site-dev@apache.org
> > To: site-dev@apache.org
> >
> > I suppose that we should first clarify our purpose,
> > then send an email to pmcs@ asking for people to help
> > from the beginning and so enable ownership.
> >
> > There was a recent flurry of discussion on infrastructure@
> > when Noel suggested we finally have the machinery to establish
> > a site build and staging server. ...
> >
> > Noel J. Bergman wrote:
> >
> >> Justin Erenkrantz wrote:
> >>
> >> > I don't see the need for a zone dedicated to creating the apache.org
> >> > sites.  Why can't each PMC have their own zone and create their
> >> > site in it however they want to do it?
> >>
> >> We need a single place for infrastructure to restore from if we have a
> >> problem, right?  And we are trying to move away from having to keep huge
> >> quantities of generated artifacts in source control just for the 
> >> purpose of
> >> restoring the web-site.
> >>
> >> So the primary goals are:
> >>
> >>   - have a means to build all of the web sites from source control
> >>   - provide for human review of the staged content
> >>   - push the approved content to a publishing area
> >>   - have the live web servers sync from the publishing area
> >>
> >> So, we reduce the need for shell accounts related to publishing, 
> >> remove the
> >> need to keep generated sites in source control, improve disaster 
> >> recovery.
> >>
> >>       --- Noel
> >
> >
> > This has been discussed many times before on infrastructure.
> > I tried to summarise some of the needs at one stage.
> > http://forrest.apache.org/0.7/proposal-asf-publish.html
> > Here is the first paragraph ...
> >
> > All ASF projects need to be able to concentrate on their projects
> > and the content of their websites, rather than get tangled up in
> > arcane website publication procedures.
> >
> > I presume that we need a site-build.zones.apache.org
> > where we would run the various documentation tools, e.g.
> > Maven, Forrest, Anakia, Ant, etc. There is also the web interface
> > for the Forrestbot which enables project committers to trigger
> > their build and review logfiles. It would need Tomcat.
> >
> > Add to that mechanisms to generate javadoc and other code docs.
> >
> > Without going into details too much, are those our aims?
> >
> > --David
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> > For additional commands, e-mail: dev-help@lenya.apache.org
> >
> >
> 
> 
> -- 
> Michael Wechner
> Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
> http://www.wyona.com                      http://lenya.apache.org
> michael.wechner@wyona.com                        michi@apache.org
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
> 
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Michael Wechner wrote:

> we just have to write a xdoc based publication which has the same 
> site-structure as
> Forrest and then export it statically into SVN, whereas the xdocs should 
> also be added
> to SVN

in the future, the generated pages will no longer be in svn, but 
otherwise it's accurate.



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Gregor J. Rothfuss wrote:

> we now have the means to use lenya (on our zone) to feed our 
> documentation. i think we should do some experiments as to how we 
> could eat our own dogfood to create the docs for the site.


sure

>
> there are lots of nice bells and whistles, but i would like us to get 
> started with something simple and then extend the solution as we use 
> it more and more.


we just have to write a xdoc based publication which has the same 
site-structure as
Forrest and then export it statically into SVN, whereas the xdocs should 
also be added
to SVN

>
> as you may have noted elsewhere, this currently a hot topic both on 
> the cocoon project, and overall. the asf has resurrected the site-dev 
> list to coordinate requirements, and there is a common site-build zone 
> that we may end up using for staging and deployment. i have attached 
> one of the key emails from that list below.
>
> i am not yet totally clear how this will all work together, but we 
> should definitely get started as soon as possible (keeping in mind 
> that we now have two community members, solprovider and jon, who 
> regularly write useful documentation)
>
> WDYT?


without being cynical, it's just a matter of doing it.

we could start such a publication within the sandbox and based on 1.4-dev
which would hopefully help to stabilize 1.4

Michi

>
> -------- Original Message --------
> Subject: mission
> Date: Wed, 11 May 2005 00:12:44 +1000
> From: David Crossley <cr...@apache.org>
> Reply-To: site-dev@apache.org
> To: site-dev@apache.org
>
> I suppose that we should first clarify our purpose,
> then send an email to pmcs@ asking for people to help
> from the beginning and so enable ownership.
>
> There was a recent flurry of discussion on infrastructure@
> when Noel suggested we finally have the machinery to establish
> a site build and staging server. ...
>
> Noel J. Bergman wrote:
>
>> Justin Erenkrantz wrote:
>>
>> > I don't see the need for a zone dedicated to creating the apache.org
>> > sites.  Why can't each PMC have their own zone and create their
>> > site in it however they want to do it?
>>
>> We need a single place for infrastructure to restore from if we have a
>> problem, right?  And we are trying to move away from having to keep huge
>> quantities of generated artifacts in source control just for the 
>> purpose of
>> restoring the web-site.
>>
>> So the primary goals are:
>>
>>   - have a means to build all of the web sites from source control
>>   - provide for human review of the staged content
>>   - push the approved content to a publishing area
>>   - have the live web servers sync from the publishing area
>>
>> So, we reduce the need for shell accounts related to publishing, 
>> remove the
>> need to keep generated sites in source control, improve disaster 
>> recovery.
>>
>>       --- Noel
>
>
> This has been discussed many times before on infrastructure.
> I tried to summarise some of the needs at one stage.
> http://forrest.apache.org/0.7/proposal-asf-publish.html
> Here is the first paragraph ...
>
> All ASF projects need to be able to concentrate on their projects
> and the content of their websites, rather than get tangled up in
> arcane website publication procedures.
>
> I presume that we need a site-build.zones.apache.org
> where we would run the various documentation tools, e.g.
> Maven, Forrest, Anakia, Ant, etc. There is also the web interface
> for the Forrestbot which enables project committers to trigger
> their build and review logfiles. It would need Tomcat.
>
> Add to that mechanisms to generate javadoc and other code docs.
>
> Without going into details too much, are those our aims?
>
> --David
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
>
>


-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Antonio Gallardo <ag...@agssa.net>.
On Mar, 24 de Mayo de 2005, 21:02, Gregor J. Rothfuss dijo:
> we now have the means to use lenya (on our zone) to feed our
> documentation. i think we should do some experiments as to how we could
> eat our own dogfood to create the docs for the site.
>
> there are lots of nice bells and whistles, but i would like us to get
> started with something simple and then extend the solution as we use it
> more and more.
>
> as you may have noted elsewhere, this currently a hot topic both on the
> cocoon project, and overall. the asf has resurrected the site-dev list
> to coordinate requirements, and there is a common site-build zone that
> we may end up using for staging and deployment. i have attached one of
> the key emails from that list below.
>
> i am not yet totally clear how this will all work together, but we
> should definitely get started as soon as possible (keeping in mind that
> we now have two community members, solprovider and jon, who regularly
> write useful documentation)
>
> WDYT?

I am +1 in join the effort and perhaps use the same solution for Cocoon.

Best Regards,

Antonio Gallardo.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "J. Wolfgang Kaltz" <ka...@interactivesystems.info>.
Gregor J. Rothfuss schrieb:
> we now have the means to use lenya (on our zone) to feed our 
> documentation. i think we should do some experiments as to how we could 
> eat our own dogfood to create the docs for the site.

Big +1 on the goal of "eating our own dogfood"

It could address 2 issues at once:
- make the process of writing & maintaining site docu less of a PITA
- sensitize all devs to the user perspective on Lenya

> (...)
> i am not yet totally clear how this will all work together, but we 
> should definitely get started as soon as possible (keeping in mind that 
> we now have two community members, solprovider and jon, who regularly 
> write useful documentation)
> 
> WDYT?

+1 on giving them edit access, if they so wish

I also don't yet understand how it would all fit together, but will try 
to help where I can.


--
Wolfgang

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Wed, 2005-05-25 at 15:26 -0400, Gregor J. Rothfuss wrote:
> Thorsten Scherler wrote:
> 
> > Due to the fact, that we have all our docs now in xdocs format I reckon
> > we should keep them in this format and I will modify some forrest
> > properties to export this docs again into the site-svn. I mean
> > editing,... in lenya and the rest like always in forrest (using the live
> > tree of the lenya instance).
> 
> the forrest site.xml would have to be generated from the lenya sitemap. 
> would you be able to work on that?

You mean sitetree.xml2site.xml.xsl?

Yeah, I will take care of that.

salu2
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Thorsten Scherler wrote:

> Due to the fact, that we have all our docs now in xdocs format I reckon
> we should keep them in this format and I will modify some forrest
> properties to export this docs again into the site-svn. I mean
> editing,... in lenya and the rest like always in forrest (using the live
> tree of the lenya instance).

the forrest site.xml would have to be generated from the lenya sitemap. 
would you be able to work on that?

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Wed, 2005-05-25 at 10:31 -0400, Gregor J. Rothfuss wrote:
> J. Wolfgang Kaltz wrote:
> 
> > Do you mean that we would edit content in Lenya, which stores it in the 
> > filesystem, then do a static export of the "site", and store the 
> > resulting html in the svn ? If so, I guess the Cocoon ReadWriteToSVN 
> > wouldn't come into play ?
> 
> no we would no longer store the rendered html in svn, but only the 
> source documents
> 
> > Or do you mean, the content we edit in Lenya is directly stored in SVN, 
> > as described in the Cocoon Wiki ? In this case, do you know if it would 
> > be enough for us to alter the publication's sitemap or would we need 
> > some custom Java code as well ?
> > In this case IIUC the static export would happen e.g. once a day, and 
> > access a running Lenya instance, which in turn accesses svn for content.
> 
> i suppose at first we could store both a copy locally in content/ and 
> save a copy to svn using the approach described in the wiki. i'm 
> interested in the easiest way possible to make this work

The thing is that on site-dev we are discussing about a central place
for the staging. If we do it "our" way (wget,...) we will have to change
that again in a couple of days/weeks/months.

Due to the fact, that we have all our docs now in xdocs format I reckon
we should keep them in this format and I will modify some forrest
properties to export this docs again into the site-svn. I mean
editing,... in lenya and the rest like always in forrest (using the live
tree of the lenya instance).

WDYT?

salu2
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Doug Chestnut <dh...@virginia.edu>.
Gregor J. Rothfuss wrote:
> i suppose at first we could store both a copy locally in content/ and 
> save a copy to svn using the approach described in the wiki. i'm 
> interested in the easiest way possible to make this work

Be sure to document the setup! :)

Would a setup like this be a temporary repository solution, or a 
foundation upon which to build.  What about the JCR/Jackrabbit 
implementation?

--Doug

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
J. Wolfgang Kaltz wrote:

> Do you mean that we would edit content in Lenya, which stores it in the 
> filesystem, then do a static export of the "site", and store the 
> resulting html in the svn ? If so, I guess the Cocoon ReadWriteToSVN 
> wouldn't come into play ?

no we would no longer store the rendered html in svn, but only the 
source documents

> Or do you mean, the content we edit in Lenya is directly stored in SVN, 
> as described in the Cocoon Wiki ? In this case, do you know if it would 
> be enough for us to alter the publication's sitemap or would we need 
> some custom Java code as well ?
> In this case IIUC the static export would happen e.g. once a day, and 
> access a running Lenya instance, which in turn accesses svn for content.

i suppose at first we could store both a copy locally in content/ and 
save a copy to svn using the approach described in the wiki. i'm 
interested in the easiest way possible to make this work

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "J. Wolfgang Kaltz" <ka...@interactivesystems.info>.
Gregor J. Rothfuss schrieb:
> (...) how about:
> 
> * install a seperate lenya 1.4 on the zone, just for docs
> * use the default publication for now
> * give lenya logins to anyone who has a proven track record with docs ;)

seems clear so far ;)

> * use wget for static export
> * also install svn 1.2 with a private repo on the zone
> * use http://wiki.apache.org/cocoon/ReadWriteToSVN to write to that 
> private repo
> 
> .. go from there.

Do you mean that we would edit content in Lenya, which stores it in the 
filesystem, then do a static export of the "site", and store the 
resulting html in the svn ? If so, I guess the Cocoon ReadWriteToSVN 
wouldn't come into play ?

Or do you mean, the content we edit in Lenya is directly stored in SVN, 
as described in the Cocoon Wiki ? In this case, do you know if it would 
be enough for us to alter the publication's sitemap or would we need 
some custom Java code as well ?
In this case IIUC the static export would happen e.g. once a day, and 
access a running Lenya instance, which in turn accesses svn for content.


--
Wolfgang

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Wed, 2005-05-25 at 19:44 -0500, Antonio Gallardo wrote:
> On Mie, 25 de Mayo de 2005, 19:26, Thorsten Scherler dijo:
> > On Wed, 2005-05-25 at 22:38 +0200, Michael Wechner wrote:
> >> Gregor J. Rothfuss wrote:
> >>
> >> > Gregor J. Rothfuss wrote:
> >> >
> >> >> we now have the means to use lenya (on our zone) to feed our
> >> >> documentation. i think we should do some experiments as to how we
> >> >> could eat our own dogfood to create the docs for the site.
> >> >>
> >> >> there are lots of nice bells and whistles, but i would like us to get
> >> >> started with something simple and then extend the solution as we use
> >> >> it more and more.
> >> >
> >> >
> >> > while i think the end goal should be
> >> > http://wiki.apache.org/cocoon/Doco , we can start small. how about:
> >> >
> >> > * install a seperate lenya 1.4 on the zone, just for docs
> >> > * use the default publication for now
> >>
> >>
> >> I think it will be faster and simpler to build a specific publication
> >> for xdocs.
> >>
> >
> > :)
> >
> > +1
> 
> +1
> 
> >
> >> > * give lenya logins to anyone who has a proven track record with docs
> >> ;)
> >>
> >>
> >> why not to everyone who wants to and use a proper Workflow, where only
> >> committer
> >> and people with a proven track record can review?
> >>
> >
> > The idea is IMO (!!!) to connect lenya to an ASF ldap server. This
> > server will keep track of *all* ASF user/dev/committer/member (in short
> > user of the ASF). Of course this should be manageable through a web
> > interface. ;-)
> >
> > Then this user of the ASF will be divided into different roles
> > (user/dev/commmitter/member). Each role have different rights to
> > approach the documentation of the projects
> > (lenya(PMC)/forrest(PMC)/cocoon(PMC)/top-level docu (members)).
> >
> > I guess the minimum requirement for contribution *is* an account on this
> > server.
> >
> > I guess we should start by setting up a ldap server in our zone and
> > maybe move it later on to infrastructure (to help their out). User (like
> > you and me) can register and would be associated with a role.
> >
> > WDYT?
> 
> For now, I think we don't need to think about a LDAP server.
> 
> I think we should keep this project the most simple posible to show up a
> solution in the next few days. The most important is to show somehow a
> proof on concept. Show that is posible using lenya write our own
> documentation. Later we can add more features: LDAP server support for
> managing user accounts, forrest integration, etc.
> 
> WDYT?
> 
> Best Regards,
> 
> Antonio Gallardo

Yeah, you are right.

+1

salu2
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Antonio Gallardo <ag...@agssa.net>.
On Mie, 25 de Mayo de 2005, 19:26, Thorsten Scherler dijo:
> On Wed, 2005-05-25 at 22:38 +0200, Michael Wechner wrote:
>> Gregor J. Rothfuss wrote:
>>
>> > Gregor J. Rothfuss wrote:
>> >
>> >> we now have the means to use lenya (on our zone) to feed our
>> >> documentation. i think we should do some experiments as to how we
>> >> could eat our own dogfood to create the docs for the site.
>> >>
>> >> there are lots of nice bells and whistles, but i would like us to get
>> >> started with something simple and then extend the solution as we use
>> >> it more and more.
>> >
>> >
>> > while i think the end goal should be
>> > http://wiki.apache.org/cocoon/Doco , we can start small. how about:
>> >
>> > * install a seperate lenya 1.4 on the zone, just for docs
>> > * use the default publication for now
>>
>>
>> I think it will be faster and simpler to build a specific publication
>> for xdocs.
>>
>
> :)
>
> +1

+1

>
>> > * give lenya logins to anyone who has a proven track record with docs
>> ;)
>>
>>
>> why not to everyone who wants to and use a proper Workflow, where only
>> committer
>> and people with a proven track record can review?
>>
>
> The idea is IMO (!!!) to connect lenya to an ASF ldap server. This
> server will keep track of *all* ASF user/dev/committer/member (in short
> user of the ASF). Of course this should be manageable through a web
> interface. ;-)
>
> Then this user of the ASF will be divided into different roles
> (user/dev/commmitter/member). Each role have different rights to
> approach the documentation of the projects
> (lenya(PMC)/forrest(PMC)/cocoon(PMC)/top-level docu (members)).
>
> I guess the minimum requirement for contribution *is* an account on this
> server.
>
> I guess we should start by setting up a ldap server in our zone and
> maybe move it later on to infrastructure (to help their out). User (like
> you and me) can register and would be associated with a role.
>
> WDYT?

For now, I think we don't need to think about a LDAP server.

I think we should keep this project the most simple posible to show up a
solution in the next few days. The most important is to show somehow a
proof on concept. Show that is posible using lenya write our own
documentation. Later we can add more features: LDAP server support for
managing user accounts, forrest integration, etc.

WDYT?

Best Regards,

Antonio Gallardo

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Antonio Gallardo <ag...@agssa.net>.
On Mie, 25 de Mayo de 2005, 19:40, Gregor J. Rothfuss dijo:
> Thorsten Scherler wrote:
>
>> I guess we should start by setting up a ldap server in our zone and
>> maybe move it later on to infrastructure (to help their out). User (like
>> you and me) can register and would be associated with a role.
>
> way too complicated. if someone needs an account, its a 1 minute thing
> to set one up in the admin area

+1.

Even better, later we can setup an auto mail response system for new
accounts. But this are just improvements in future versions. ;-)

Best Regards,

Antonio Gallardo


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Thorsten Scherler wrote:

> I guess we should start by setting up a ldap server in our zone and
> maybe move it later on to infrastructure (to help their out). User (like
> you and me) can register and would be associated with a role. 

way too complicated. if someone needs an account, its a 1 minute thing 
to set one up in the admin area

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Thorsten Scherler <th...@apache.org>.
On Wed, 2005-05-25 at 22:38 +0200, Michael Wechner wrote: 
> Gregor J. Rothfuss wrote:
> 
> > Gregor J. Rothfuss wrote:
> >
> >> we now have the means to use lenya (on our zone) to feed our 
> >> documentation. i think we should do some experiments as to how we 
> >> could eat our own dogfood to create the docs for the site.
> >>
> >> there are lots of nice bells and whistles, but i would like us to get 
> >> started with something simple and then extend the solution as we use 
> >> it more and more.
> >
> >
> > while i think the end goal should be 
> > http://wiki.apache.org/cocoon/Doco , we can start small. how about:
> >
> > * install a seperate lenya 1.4 on the zone, just for docs
> > * use the default publication for now
> 
> 
> I think it will be faster and simpler to build a specific publication 
> for xdocs.
> 

:)

+1

> > * give lenya logins to anyone who has a proven track record with docs ;)
> 
> 
> why not to everyone who wants to and use a proper Workflow, where only 
> committer
> and people with a proven track record can review?
> 

The idea is IMO (!!!) to connect lenya to an ASF ldap server. This
server will keep track of *all* ASF user/dev/committer/member (in short
user of the ASF). Of course this should be manageable through a web
interface. ;-)

Then this user of the ASF will be divided into different roles
(user/dev/commmitter/member). Each role have different rights to
approach the documentation of the projects
(lenya(PMC)/forrest(PMC)/cocoon(PMC)/top-level docu (members)). 

I guess the minimum requirement for contribution *is* an account on this
server.

I guess we should start by setting up a ldap server in our zone and
maybe move it later on to infrastructure (to help their out). User (like
you and me) can register and would be associated with a role. 

WDYT?

salu2
thorsten

> Michi
> 
> > * use wget for static export
> > * also install svn 1.2 with a private repo on the zone
> > * use http://wiki.apache.org/cocoon/ReadWriteToSVN to write to that 
> > private repo
> >
> > .. go from there.
> >
> > this way we can explore how all this can work together, without dying 
> > from trying to do too much at once.
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> > For additional commands, e-mail: dev-help@lenya.apache.org
> >
> >
> 
> 
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by Michael Wechner <mi...@wyona.com>.
Gregor J. Rothfuss wrote:

> Gregor J. Rothfuss wrote:
>
>> we now have the means to use lenya (on our zone) to feed our 
>> documentation. i think we should do some experiments as to how we 
>> could eat our own dogfood to create the docs for the site.
>>
>> there are lots of nice bells and whistles, but i would like us to get 
>> started with something simple and then extend the solution as we use 
>> it more and more.
>
>
> while i think the end goal should be 
> http://wiki.apache.org/cocoon/Doco , we can start small. how about:
>
> * install a seperate lenya 1.4 on the zone, just for docs
> * use the default publication for now


I think it will be faster and simpler to build a specific publication 
for xdocs.

> * give lenya logins to anyone who has a proven track record with docs ;)


why not to everyone who wants to and use a proper Workflow, where only 
committer
and people with a proven track record can review?

Michi

> * use wget for static export
> * also install svn 1.2 with a private repo on the zone
> * use http://wiki.apache.org/cocoon/ReadWriteToSVN to write to that 
> private repo
>
> .. go from there.
>
> this way we can explore how all this can work together, without dying 
> from trying to do too much at once.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
>
>


-- 
Michael Wechner
Wyona Inc.  -   Open Source Content Management   -   Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: documentation prototyping with lenya (on the zone)

Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Gregor J. Rothfuss wrote:
> we now have the means to use lenya (on our zone) to feed our 
> documentation. i think we should do some experiments as to how we could 
> eat our own dogfood to create the docs for the site.
> 
> there are lots of nice bells and whistles, but i would like us to get 
> started with something simple and then extend the solution as we use it 
> more and more.

while i think the end goal should be http://wiki.apache.org/cocoon/Doco 
, we can start small. how about:

* install a seperate lenya 1.4 on the zone, just for docs
* use the default publication for now
* give lenya logins to anyone who has a proven track record with docs ;)
* use wget for static export
* also install svn 1.2 with a private repo on the zone
* use http://wiki.apache.org/cocoon/ReadWriteToSVN to write to that 
private repo

.. go from there.

this way we can explore how all this can work together, without dying 
from trying to do too much at once.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org