Now that, theoretically, the plugins are all documented up to their
current release and improvements in docs can wait until the next
release, this sounds fine to me.
However, I'm not sure how this helps the current situation, since
assembly 2.2-beta-1 is a release. It should document the places it
differs from 2.1. If it doesn't, that's a bug.
- Brett
On 21/04/2007, at 4:09 AM, Wendy Smoak wrote:
A while ago I pushed for publishing the plugin docs from svn, because
there was so much good information sitting there, invisible until a
release finally happened.
Now it's causing problems, mainly with the Assembly plugin which
changed quite a bit from 2.1 to 2.2. Also, the changes in the ASF's
release guidelines mean we should keep docs on unreleased stuff
separate from the docs intended for users of official releases.
So... I'm thinking of publishing the plugin docs to
/plugins/${artifact-id}-${version}
For example: http://maven.apache.org/plugins/maven-assembly-
plugin-2.1/
We already have to update http://maven.apache.org/plugins/index.html
with the version number, it's just a few more keystrokes to change the
link as well as the text on the page.
That means 'mvn site-deploy' Just Works, we can publish docs for the
snapshots, and it's just as easy to publish the docs for the release
with 'mvn site-deploy' from the tag.
If someone wants to link to the snapshot docs, it could be done under
the Plugin Developers page, but I'd just leave it out-- developers can
figure out what the URL is.
The users will be less confused by docs that don't match the released
plugins they're using, and we'll have some archived docs online which
we can link up or not, depending on how much the plugin has changed.
Assembly, for example, needs both sets of docs online.
Thoughts?
--
Wendy
---------------------------------------------------------------------
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]
