+1 on both. Important thing for "plugin documentation needs to be
folded into main documentation" though - I assume you mean this in a
logical way (ie, strong contextual links from the documentation to
the plugin documentation), and not a physical way?
- Brett
On 26/05/2007, at 4:02 AM, Henri Yandell wrote:
I didn't notice any threads on the doc organization topic, so thought
I'd start one. Apologies if I missed the right place, [EMAIL PROTECTED] is the
noisiest list I'm on.
Compare and contrast:
http://maven.apache.org/guides/
and
http://httpd.apache.org/docs/2.2/
---
Firstly, there is no real Maven documentation home page. It's a part
of the front page, which clashes with the sheer amount of space that
news, announcement and other things need. So suggested step 1: We need
a documentation page.
Secondly, it's obvious that much of the httpd page concerns mod_foos
that are included by default. With Maven, these plugin documentation
pages are _much_ harder to find. They're not even listed under
documentation but involve you having to know that you want to use a
plugin and then go look at its docs. So suggested step 2: Plugin
documentation needs to be folded into main documentation.
Will add more as I go; I need to dig through the wiki sprawl to
understand how this is being solved; I'm sure the above isn't news.
Hen
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
