[ 
http://jira.codehaus.org/browse/MOJO-1017?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_121438
 ] 

Benjamin Bentmann commented on MOJO-1017:
-----------------------------------------

I can see your point but I still wonder how the site can serve to document all 
versions when it in fact is generated from only a single version. E.g. if a 
deprecated mojo parameter is eventually removed from the configuration, it does 
not appear on the site and hence does not document an older version of the 
plugin.

My primary motivation for having the version info everywhere was to handle such 
misbehaving sites like for the Maven AntRun Plugin which published its SNAPSHOT 
docu to the official plugin site (see also MNG-3327). These pages document 
unreleased features that users might be tempted to use but have to discover 
that it doesn't work yet. Depending on the user's skills, it may take some time 
to track the problem down giving rise to more or less frustration. If the page 
stated "X.Y-SNAPSHOT" right in its top, it would be easier to recognize that 
the documentation may describe unreleased features.

To come to end, feel free to close this issue as "Won't fix". My sorrow can be 
dealt with by disciplined usage of staging sites. Your point remains.

> Extend site descriptor to contain <version>
> -------------------------------------------
>
>                 Key: MOJO-1017
>                 URL: http://jira.codehaus.org/browse/MOJO-1017
>             Project: Mojo
>          Issue Type: Improvement
>          Components: General
>            Reporter: Benjamin Bentmann
>            Priority: Trivial
>         Attachments: site-descriptor.patch
>
>
> Most site output already has "Last published". It would be nice to 
> additionally have the version info, too, since this is usually more important 
> for users to check whether the documentation matches the version they are 
> using.
> Note that inheritance of the <version> element is known to fail with the 
> maven-site-plugin:2.0-beta-5 (MSITE-247). However, I do not recommend to 
> update to maven-site-plugin:2.0-beta-6 either (MSITE-279). Nevertheless, it 
> would be nice to have these additions in the parent site descriptor for the 
> day where the site tools properly handle inheritance.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

Reply via email to