svn commit: r984466 - in /maven/plugins/trunk/maven-site-plugin/src/site: apt/index.apt apt/migrate.apt site.xml

[de...@apache.org]

Author: dennisl
Date: Wed Aug 11 16:33:52 2010
New Revision: 984466

URL: http://svn.apache.org/viewvc?rev=984466&view=rev
Log:
o Create a migration document describing how to migrate from one version to another.

Added:
    maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt   (with props)
Modified:
    maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-site-plugin/src/site/site.xml

Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt?rev=984466&r1=984465&r2=984466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt Wed Aug 11 16:33:52 2010
@@ -32,14 +32,7 @@ Maven Site Plugin
  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 <<<\<reporting\>>>> section of the POM.
 
- If you consider <<upgrading to site-plugin-2.1>>, please note that there have been a couple of important changes.
- First, the plugin now requires at least <<Maven 2.1.x>> to run, you cannot use it with older Maven versions.
- Second, and most notable, site-plugin-2.1 has been upgraded to use <<Doxia 1.1>>, which has seen a lot of major
- changes itself. If you experience unexpected behavior, please read
- {{{http://maven.apache.org/doxia/whatsnew-1.1.html}Doxia: what's new in 1.1?}},
- {{{http://maven.apache.org/doxia/references/doxia-apt.html}Doxia: Enhancements to the APT format}},
- {{{http://maven.apache.org/doxia/issues/index.html}Doxia: Issues & Gotchas}}, and the
- {{{http://maven.apache.org/doxia/faq.html}Doxia: Frequently Asked Questions}} first.
+ Please read the {{{migrate.html}migration guide}} if you want to upgrade the Site Plugin.
 
 * Goals Overview
 

Added: maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt?rev=984466&view=auto
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt (added)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt Wed Aug 11 16:33:52 2010
@@ -0,0 +1,55 @@
+ ------
+ Migrate
+ ------
+ Dennis Lundberg
+ ------
+ 2010-08-11
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements.  See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership.  The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License.  You may obtain a copy of the License at
+ ~~
+ ~~   http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied.  See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+Migrate
+
+  The Site Plugin has had a couple of upgrades that requires the user to make
+  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.0.x to 2.1.x
+
+  * The plugin now requires at least <<Maven 2.1>> to run, you cannot use it
+  with older Maven versions.
+
+  * The plugin has been upgraded to use <<Doxia 1.1>>, which has seen a lot of
+  major changes itself. If you experience unexpected behavior, please read these
+  resources:
+
+    * {{{http://maven.apache.org/doxia/whatsnew-1.1.html}Doxia: what's new in 1.1?}}
+
+    * {{{http://maven.apache.org/doxia/references/doxia-apt.html}Doxia: Enhancements to the APT format}}
+
+    * {{{http://maven.apache.org/doxia/issues/index.html}Doxia: Issues & Gotchas}}
+
+    * {{{http://maven.apache.org/doxia/faq.html}Doxia: Frequently Asked Questions}}
+
+    []
+
+  []

Propchange: maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: maven/plugins/trunk/maven-site-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/site.xml?rev=984466&r1=984465&r2=984466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/site.xml Wed Aug 11 16:33:52 2010
@@ -28,6 +28,7 @@ under the License.
       <item name="Goals" href="plugin-info.html"/>
       <item name="Usage" href="usage.html"/>
       <item name="FAQ" href="faq.html"/>
+      <item name="Migrate" href="migrate.html"/>
     </menu>
     <menu name="Configuration">
       <item name="Internationalization" href="i18n.html"/>