svn commit: r1149489 - in /maven/plugins/branches/maven-site-plugin-3.x/src/site/apt: index.apt maven-3.apt.vm migrate.apt

[lt...@apache.org]

Author: ltheussl
Date: Fri Jul 22 07:49:25 2011
New Revision: 1149489

URL: http://svn.apache.org/viewvc?rev=1149489&view=rev
Log:
doc polishing

Modified:
    maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/index.apt
    maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/maven-3.apt.vm
    maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/migrate.apt

Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/index.apt?rev=1149489&r1=1149488&r2=1149489&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/index.apt (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/index.apt Fri Jul 22 07:49:25 2011
@@ -27,11 +27,13 @@
  ~~ http://maven.apache.org/doxia/references/apt-format.html
 
 
-Maven Site Plugin
+Maven Site Plugin - 3.x
 
  The Site Plugin is used to generate a site for the project. The generated site also includes the project's reports
  that were configured in the POM.
 
+ This is the site for <<version 3>> of the maven-site-plugin. It requires at least Maven 2.2.0 to run.
+
  Please read the {{{./migrate.html}migration guide}} if you want to upgrade the Site Plugin.
 
 * Goals Overview

Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/maven-3.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/maven-3.apt.vm?rev=1149489&r1=1149488&r2=1149489&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/maven-3.apt.vm (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/maven-3.apt.vm Fri Jul 22 07:49:25 2011
@@ -29,13 +29,18 @@
 
 Maven Site Plugin with Maven 3.x
 
-  Due to {{{http://jira.codehaus.org/browse/MNG-4162}MNG-4162}}, all reporting logic has been removed from Maven 3.
-  So a branch of the Site Plugin has been created,
-  <<<{{{https://svn.apache.org/repos/asf/maven/plugins/branches/maven-site-plugin-3.x/}/maven/plugins/branches/maven-site-plugin-3.x}}>>>
-  in order to get the Site Plugin working with Maven 3.x.
+  A major aim of the refactoring in Maven 3.x was to decouple the Maven core from Doxia
+  and to allow arbitrary reporting systems to be developed. For this reason, all reporting
+  related code has been removed from the core of Maven 3
+  ({{{http://jira.codehaus.org/browse/MNG-4162}MNG-4162}}).
+  As a result, the 2.x versions of the Maven Site Plugin will no longer work with Maven 3.
   Using previous versions of maven-site-plugin with Maven 3.x won't generate reports from any report plugin,
   only hand-written Doxia documents (apt, xdoc, ...) will be rendered.
 
+  Therefore this
+  <<<{{{https://svn.apache.org/repos/asf/maven/plugins/branches/maven-site-plugin-3.x/}3.x branch}}>>>
+  of the Site Plugin has been created, in order to get the Site Plugin working with Maven 3.x.
+
 * Plugins Compatibility Matrix
 
 ** Plugins Maintained by the Apache Maven Community
@@ -43,7 +48,7 @@ Maven Site Plugin with Maven 3.x
   Tests have been made on the reporting profile of the Maven parent POM which enables some reports.
   You will need so update some of those plugins for them to work with Maven 3.x. Below you will find the minimum version
   required for these plugins to work in Maven 3.
-  
+
 *-----------------------------------+-----------+
 | <<Plugin>>                        |<<Version>>|
 *-----------------------------------+-----------+
@@ -116,8 +121,8 @@ Maven Site Plugin with Maven 3.x
       </plugin>
     </plugins>
   </reporting>
-+-----+  
-  
++-----+
+
 ** New Configuration (Maven 3 only, no reports configuration inheritance)
 
   Reports can be configured in the configuration for <<<maven-site-plugin>>> too as <<<\<reportPlugins\>>>> elements.
@@ -169,15 +174,36 @@ Maven Site Plugin with Maven 3.x
   The following order/strategy will be used to find/resolve a version:
 
   * search same groupId/artifactId in the build.plugins section
-  
+
   * search same groupId/artifactId in the build.pluginManagement.plugins section
-  
+
   * resolve with current repositories (can include auto SNAPSHOT resolution)
 
 * Site descriptor attachment
 
-  <<<site:attach-descriptor>>> have been removed from the built-in lifecycle of Maven 3. Have a look at
-  {{{https://cwiki.apache.org/confluence/display/MAVEN/Maven+3.x+Compatibility+Notes#Maven3.xCompatibilityNotes-SiteandReporting}Maven 3.x Compatibility Notes - Site and Reporting}}.
+  In Maven 3, the default execution of <<<site:attach-descriptor>>> has been removed from the
+  built-in lifecycle bindings for projects with packaging "pom". Users that actually use those
+  projects to provide a common site descriptor for sub modules will need to explicitly define
+  the following goal execution to restore the intended behavior:
+
++-----+
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-site-plugin</artifactId>
+        <version>3.0-beta-2</version>
+        <executions>
+          <execution>
+            <id>attach-descriptor</id>
+            <goals>
+              <goal>attach-descriptor</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
++-----+
 
 * Using one version of maven-site-plugin for both Maven 2.2.x and Maven 3.x
 

Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/migrate.apt
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/migrate.apt?rev=1149489&r1=1149488&r2=1149489&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/migrate.apt (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/migrate.apt Fri Jul 22 07:49:25 2011
@@ -33,13 +33,11 @@ Migrate
   adjustments to their environment, documents or configuration. Below is a list
   of these changes and what you as a user need to be aware of.
 
-* From 2.x to 3.0
+* From 2.x to 3.x
 
   * Version 3 of the plugin requires at least <<Maven 2.2.0>> to run.
 
-  * If you use <<Maven 3>> you need to update {{{./maven-3.html}some report plugins versions}}.
-
-~~ TODO Copy the content from the wiki to here and kill the wiki page when we are ready for the 3.0 release
+  * If you use <<Maven 3>> please read the {{{./maven-3.html}Maven 3}} guide about relevant issues.
 
   []