+ update README.md

+ update javadocs
+ try to add more reports plugins (hard with a multi-module Maven project)
This commit is contained in:
Costin Leau
2010-12-03 14:06:31 +02:00
parent 5463f1f21c
commit eadd1526e5
3 changed files with 143 additions and 82 deletions

View File

@@ -7,7 +7,7 @@ As the name implies, the **Key Value** modules provides integration with key val
Getting Help
------------
Read the main project [website](http://www.springsource.org/spring-data)) and the [User Guide](http://static.springsource.org/spring-data/datastore-keyvalue/snapshot-site/reference/html/). Look at the source code and the [JavaDocs](http://static.springsource.org/spring-data/data-keyvalue/snapshot-site/spring-data-redis/apidocs/). For more detailed questions, use the [forum](http://forum.springsource.org/forumdisplay.php?f=80). If you are new to Spring as well as to Spring Data, look for information about [Spring projects](http://www.springsource.org/projects).
Read the main project [website](http://www.springsource.org/spring-data)) and the [User Guide](http://static.springsource.org/spring-data/datastore-keyvalue/snapshot-site/reference/html/). Look at the source code and the [JavaDocs](http://static.springsource.org/spring-data/data-keyvalue/snapshot-site/apidocs/). For more detailed questions, use the [forum](http://forum.springsource.org/forumdisplay.php?f=80). If you are new to Spring as well as to Spring Data, look for information about [Spring projects](http://www.springsource.org/projects).
Quick Start
-----------
@@ -21,11 +21,10 @@ For those in a hurry:
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-keyvalue</artifactId>
<artifactId>spring-data-redis</artifactId>
<version>1.0.0-BUILD-SNAPSHOT</version>
</dependency>
<repository>
<id>spring-maven-snapshot</id>
<snapshots><enabled>true</enabled></snapshots>

167
pom.xml
View File

@@ -10,6 +10,7 @@
<properties>
<javadoc.loc>src/main/javadoc</javadoc.loc>
<findbugs.skip>false</findbugs.skip>
</properties>
<modules>
@@ -19,6 +20,83 @@
<module>spring-data-riak</module>
</modules>
<organization>
<name>SpringSource</name>
<url>http://www.SpringSource.org</url>
</organization>
<developers>
<developer>
<id>mpollack</id>
<name>Mark Pollack</name>
<email>mpollack at vmware.com</email>
<organization>SpringSource</organization>
<organizationUrl>http://www.SpringSource.com</organizationUrl>
<roles>
<role>Project Admin</role>
<role>Developer</role>
</roles>
<timezone>-5</timezone>
</developer>
<developer>
<id>cleau</id>
<name>Costin Leau</name>
<email>cleau at vmware.com</email>
<organization>SpringSource</organization>
<organizationUrl>http://www.SpringSource.com</organizationUrl>
<roles>
<role>Developer</role>
</roles>
<timezone>+2</timezone>
</developer>
</developers>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0</url>
<comments>
Copyright 2010 the original author or authors.
Licensed 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.
</comments>
</license>
</licenses>
<issueManagement>
<system>JIRA</system>
<url>
http://jira.springframework.org/browse/DATAKV
</url>
</issueManagement>
<ciManagement>
<system>bamboo</system>
<url>http://build.springframework.org/browse/DATAKV</url>
</ciManagement>
<scm>
<connection>
scm:git:git://github.com/SpringSource/spring-data-keyvalue.git
</connection>
<developerConnection>
scm:git:git@github.com:SpringSource/spring-data-keyvalue.git
</developerConnection>
<url>http://fisheye.springsource.org/browse/datakv</url>
</scm>
<inceptionYear>2010</inceptionYear>
<build>
<extensions>
@@ -157,31 +235,17 @@
</plugins>
<finalName>${dist.finalName}</finalName>
-->
<plugin>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<phase>pre-site</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
-->
</plugins>
</build>
<reporting>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<executions>
<execution>
<id>aggregate</id>
<phase>pre-site</phase>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
<configuration>
<javadoc:aggregate>true</javadoc:aggregate>
<breakiterator>true</breakiterator>
@@ -197,7 +261,7 @@
<groups>
<group>
<title>Spring Data Key Value Core</title>
<packages>org.springframework.data.keyvalue.core*</packages>
<packages>org.springframework.data.keyvalue*</packages>
</group>
<group>
<title>Spring Data Redis Support</title>
@@ -213,10 +277,61 @@
<link>http://download.oracle.com/javase/6/docs/api/</link>
</links>
</configuration>
</plugin>
</plugins>
</build>
</plugin>
<plugin>
<artifactId>maven-source-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jxr-maven-plugin</artifactId>
</plugin>
<!-- ============== -->
<!-- FindBugs -->
<!-- ============== -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>2.3.1</version>
<configuration>
<!--
<xmlOutput>true</xmlOutput>
<xmlOutputDirectory>target</xmlOutputDirectory>
-->
<threshold>Normal</threshold>
<effort>Default</effort>
<!--
<debug>true</debug>
<relaxed>true</relaxed>
-->
<skip>${findbugs.skip}</skip>
</configuration>
</plugin>
<!-- ============== -->
<!-- jDepend -->
<!-- ============== -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jdepend-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
<version>2.6</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
</plugin>
</plugins>
</reporting>
<distributionManagement>
<!-- see 'staging' profile for dry-run deployment settings -->
<downloadUrl>http://www.springsource.com/spring-data</downloadUrl>

View File

@@ -35,61 +35,8 @@
<javadoc.loc>../src/main/javadoc</javadoc.loc>
</properties>
<organization>
<name>SpringSource</name>
<url>http://www.SpringSource.org</url>
</organization>
<developers>
<developer>
<id>mpollack</id>
<name>Mark Pollack</name>
<email>mpollack at vmware.com</email>
<organization>SpringSource</organization>
<organizationUrl>http://www.SpringSource.com</organizationUrl>
<roles>
<role>Project Admin</role>
<role>Developer</role>
</roles>
<timezone>-5</timezone>
</developer>
<developer>
<id>cleau</id>
<name>Costin Leau</name>
<email>cleau at vmware.com</email>
<organization>SpringSource</organization>
<organizationUrl>http://www.SpringSource.com</organizationUrl>
<roles>
<role>Developer</role>
</roles>
<timezone>+2</timezone>
</developer>
</developers>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0</url>
<comments>
Copyright 2010 the original author or authors.
Licensed 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.
</comments>
</license>
</licenses>
<profiles>
<profile>
<id>strict</id>