You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lenya.apache.org by Andreas Hartmann <an...@apache.org> on 2008/08/25 16:50:55 UTC

Shipping the docu as default publication

Hi Lenya devs,

there seems to be a consensus that it would be a good idea to ship the 
docu publication as an example instead of the default publication.

This raises the question how the content should be handled. A 
fundamental issue is that each installation would contain a fork of the 
website content. Do you consider this a problem? Could it cause confusion?

There are several options:

a) Use a separate SVN repository for the content which is shared by the 
project website and the application (e.g., via svn:externals). This 
would require to commit our website content (potentially cumbersome, 
might be automated).

b) Don't include the full documentation content, but only a couple of 
pages which aren't likely to change often, and try to keep these pages 
up to date.

c) Use the content of the current default publication, i.e. share only 
the layout.

d) Don't include any meaningful content at all, only some "Hello World" 
pages. This would require only a minimum of maintenance.

e) …

WDYT?

-- Andreas

-- 
Andreas Hartmann, CTO
BeCompany GmbH
http://www.becompany.ch
Tel.: +41 (0) 43 818 57 01


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


Re: Shipping the docu as default publication

Posted by Andreas Hartmann <an...@apache.org>.
Thomas Comiotto schrieb:
> On Aug 25, 2008, at 5:15 PM, Richard Frovarp wrote:
> 
>> Andreas Hartmann wrote:
>>> Hi Lenya devs,
>>>
>>> there seems to be a consensus that it would be a good idea to ship 
>>> the docu publication as an example instead of the default publication.
> 
> I think it's important to ship Lenya with both default and docu 
> publication. They have different target domains (i.e. tech-docu vs. web 
> publishing) and both serve as showcase and template for people building 
> their own customized publications. Shipping Lenya with docu publication 
> only will lead to the first impression that you deal with a system for 
> technical documentation only.

I agree to these points. But instead of shipping multiple independent 
sample publications, I'd rather suggest to emphasize the modularity of 
Lenya and the publication templating concept.

Here's another random thought:

- Create a "base" pub defining all page generation pipelines
- Use the base pub as a template for both docu and example pub
- Use different layouts for docu and example pub (see below)
- Enable the news module (and other upcoming modules) in the example pub

All editors should work out of the box in all publications derived from 
the base pub. We can tell people that they risk breaking the editor 
support if they don't use the base pub as template. Since the base pub 
defines the page flow and the other publications only override the 
XSLTs, this should be no problem (given that the editors support the 
resource types).

This way we would keep the "concrete" publications (docu and example) 
minimal. I can imagine this makes it easier to get started with a new 
publication.

By using different layouts for docu and example pub, we show how the 
layout can be customized.

WDYT?

-- Andreas


-- 
Andreas Hartmann, CTO
BeCompany GmbH
http://www.becompany.ch
Tel.: +41 (0) 43 818 57 01


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


Re: Shipping the docu as default publication

Posted by Thomas Comiotto <th...@id.uzh.ch>.
Hi all


On Aug 25, 2008, at 5:15 PM, Richard Frovarp wrote:

> Andreas Hartmann wrote:
>> Hi Lenya devs,
>>
>> there seems to be a consensus that it would be a good idea to ship  
>> the docu publication as an example instead of the default  
>> publication.

I think it's important to ship Lenya with both default and docu  
publication. They have different target domains (i.e. tech-docu vs.  
web publishing) and both serve as showcase and template for people  
building their own customized publications. Shipping Lenya with docu  
publication only will lead to the first impression that you deal with  
a system for technical documentation only.

Btw, the default publication could (should) be beefed up a bit to  
better meet common expectations, say with a forum and a blog/ 
syndication module.

Bests
Thomas







------------------------------------------------------------------------ 
-----
                         Thomas Comiotto              
thomas.comiotto@id.uzh.ch

                         Universitaet Zuerich
                         Informatikdienste                Tel: +41 44  
63 54541
                         Winterthurerstrasse 190               +41 44  
63 43333
                         CH-8057 Zuerich                  Fax: +41 44  
63 54505





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


Re: Shipping the docu as default publication

Posted by Richard Frovarp <ri...@sendit.nodak.edu>.
Andreas Hartmann wrote:
> Hi Lenya devs,
>
> there seems to be a consensus that it would be a good idea to ship the 
> docu publication as an example instead of the default publication.
>
> This raises the question how the content should be handled. A 
> fundamental issue is that each installation would contain a fork of 
> the website content. Do you consider this a problem? Could it cause 
> confusion?
>
> There are several options:
>
> c) Use the content of the current default publication, i.e. share only 
> the layout.
>
This one makes the most sense to me. Maybe update some of the content as 
appropriate. It would seem appropriate to showcase the functionality of 
the system in the default publication. Docu doesn't use the news module 
for instance.

Richard

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