On 8/14/06, Matthias Wessendorf <[EMAIL PROTECTED]> wrote:

Hi,

this email contains two things.

a) Call for help on documentation:
If you like to provide some documentation about the Trinidad plugins,
feel free to add content to the wiki. Or provide xdoc or apt patches
;)

b) Structure:
There are two options for handling the doc structure:
1. create a site module, which contains *all* documentation
2. having each (sub)project/plugin having it's own src/site and *compose*
it.

Shale uses the first (for instance). See [1] for David Geary's remote
example. MyFaces uses the second.

What do you like more ?


Regarding Shale's approach, my desired destination is actually more towards
[2], but it really depends on how your Maven modules are organized.  For
example, the shale-core module supports many, but not all, of the available
features ... so it's natural to have features pages in the core website for
those features.  But modules like shale-spring have a related 'features'
page too ... and that should really be hosted by the shale-spring Maven
module, not by the parent module.  The current organization is more a
byproduct of the Ant-based original organization, and doesn't reflect what
would have happened if we had started with Maven2 in the first place.

The challenge, of course, is that users of the website don't really care
about Maven modules ... they care about finding out the features of the
project as a whole.  So, some attention will be needed on the menu
organization to make sure their needs are also met.

-Matt


Craig

[1] http://shale.apache.org/features-remoting.html
--
Matthias Wessendorf

further stuff:
blog: http://jroller.com/page/mwessendorf
mail: mwessendorf-at-gmail-dot-com

Reply via email to