improved site structure for ducumentation

git-svn-id: https://svn.apache.org/repos/asf/maven/release/trunk@1139411 13f79535-47bb-0310-9956-ffa450edef68
apache · Jun 24, 2011 · 6c5d32f · 6c5d32f
1 parent b6ea86b
commit 6c5d32f
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 0 deletions.
diff --git a/maven-release-manager/src/site/site.xml b/maven-release-manager/src/site/site.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html"/>
+      <item name="JavaDocs" href="apidocs/index.html"/>
+      <item name="Source Xref" href="xref/index.html"/>
+      <!--item name="FAQ" href="faq.html"/-->
+    </menu>
+
+    <menu ref="parent" inherit="top" />
+  </body>
+</project>
diff --git a/pom.xml b/pom.xml
@@ -34,6 +34,7 @@
   <packaging>pom</packaging>
 
   <name>Maven Release</name>
+  <description>Tooling to release a project with Maven, saving a lot of repetitive, manual work.</description>
 
   <mailingLists>
     <mailingList>

diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
@@ -0,0 +1,20 @@
+ ------
+ Maven Release
+ ------
+ Hervé Boutemy
+ ------
+ 2011-06-24
+ ------
+
+Maven Release
+
+ Maven Release provides tooling to release a project with Maven, saving a lot of repetitive, manual work.
+
+ It consists of following modules:
+*----------------------------------------------------------+----------------+
+|| Module                                                  || Description   ||
+*----------------------------------------------------------+----------------+
+| {{{./maven-release-plugin/}maven-release-plugin}}        | core classes,
+*----------------------------------------------------------+----------------+
+| {{{/plugins/maven-release-plugin/}maven-release-plugin}} | release plugin to use from Maven.
+*----------------------------------------------------------+----------------+
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+  <body>
+    <menu ref="modules" inherit="bottom" />
+    <menu ref="reports" inherit="bottom" />
+  </body>
+</project>