Permalink
Browse files

DATAREDIS-266 - Update Documentation.

Updated links in javadoc. Added API javadoc with references to the redis commands. Updated reference manual. Updated Readme and contributing guide.
Updated (SCM and developer information in) gradle build and template.mf bundle manifest.

Original pull request: #38
  • Loading branch information...
1 parent e003ef6 commit 3a49fd14e52ad86a82e751c98b7ded10d3dd767a @christophstrobl christophstrobl committed with thomasdarimont Feb 17, 2014
View
@@ -2,9 +2,9 @@
Here are some ways for you to get involved in the community:
-* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?87-Hadoop) by responding to questions and joining the debate.
-* Create [JIRA](https://jira.springframework.org/browse/SHDP) tickets for bugs and new features and comment and vote on the ones that you are interested in.
-* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org.
+* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.spring.io/forum/spring-projects/data/nosql) by responding to questions and joining the debate.
+* Create [JIRA](https://jira.springframework.org/browse/DATAREDIS) tickets for bugs and new features and comment and vote on the ones that you are interested in.
+* Watch for upcoming articles on Spring by [subscribing](https://spring.io/blog) to spring.io.
-Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, read the Spring Framework [contributor guidelines] (https://github.com/SpringSource/spring-framework/blob/master/CONTRIBUTING.md).
+Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, read the Spring Framework [contributor guidelines] (https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md).
View
@@ -6,11 +6,11 @@ This modules provides integration with the [Redis] (http://redis.io/) store.
# Docs
-You can find out more details from the [user documentation](http://static.springsource.org/spring-data/redis/docs/current/reference/) or by browsing the [javadocs](http://static.springsource.org/spring-data/redis/docs/current/api/).
+You can find out more details from the [user documentation](http://docs.spring.io/spring-data/data-redis/docs/current/reference/html/) or by browsing the [javadocs](http://docs.spring.io/spring-data/data-redis/docs/current/api/).
# Examples
-For examples on using the Spring Data Key Value, see the dedicated project, also available on [GitHub](https://github.com/SpringSource/spring-data-keyvalue-examples)
+For examples on using the Spring Data Key Value, see the dedicated project, also available on [GitHub](https://github.com/spring-projects/spring-data-keyvalue-examples)
# Artifacts
@@ -29,23 +29,23 @@ For examples on using the Spring Data Key Value, see the dedicated project, also
<id>spring-maven-snapshot</id>
<snapshots><enabled>true</enabled></snapshots>
<name>Springframework Maven SNAPSHOT Repository</name>
- <url>http://repo.springsource.org/libs-release</url>
+ <url>http://repo.spring.io/libs-release</url>
</repository>
<!-- used for milestone/rc releases -->
<repository>
<id>spring-maven-milestone</id>
<name>Springframework Maven Milestone Repository</name>
- <url>http://repo.springsource.org/libs-milestone</url>
+ <url>http://repo.spring.io/libs-milestone</url>
</repository>
~~~~~
* Gradle:
~~~~~ groovy
repositories {
- maven { url "http://repo.springsource.org/libs-milestone" }
- maven { url "http://repo.springsource.org/libs-snapshot" }
+ maven { url "http://repo.spring.io/libs-milestone" }
+ maven { url "http://repo.spring.io/libs-snapshot" }
}
// used for nightly builds
@@ -54,7 +54,7 @@ dependencies {
}
~~~~~
-Latest GA release is _1.1.0.RELEASE_
+Latest GA release is _1.1.1.RELEASE_
Latest nightly is _1.2.0.BUILD-SNAPSHOT_
# Usage (for the impatient)
@@ -112,13 +112,13 @@ depending on your editor.
Here are some ways for you to get involved in the community:
-* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?80-NoSQL) by responding to questions and joining the debate.
+* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.spring.io/forum/spring-projects/data/nosql) by responding to questions and joining the debate.
* Create [JIRA](https://jira.springframework.org/browse/DATAREDIS) tickets for bugs and new features and comment and vote on the ones that you are interested in.
-* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org.
+* Watch for upcoming articles on Spring by [subscribing](https://spring.io/blog) to spring.io.
-Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, read the Spring Framework [contributor guidelines] (https://github.com/SpringSource/spring-framework/blob/master/CONTRIBUTING.md).
+Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, read the Spring Framework [contributor guidelines] (https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md).
# Staying in touch
Follow the project team ([@thomasdarimont](http://twitter.com/thomasdarimont), [@stroblchristoph](http://twitter.com/stroblchristoph)) on Twitter. In-depth articles can be
-found at the SpringSource [team blog](https://spring.io/blog), and releases are announced via our [news feed](https://spring.io/blog/category/news).
+found at the Spring [team blog](https://spring.io/blog), and releases are announced via our [news feed](https://spring.io/blog/category/news).
View
@@ -1,6 +1,6 @@
buildscript {
repositories {
- maven { url 'http://repo.springsource.org/plugins-release' }
+ maven { url 'http://repo.spring.io/plugins-release' }
}
dependencies {
classpath 'org.springframework.build.gradle:bundlor-plugin:0.1.2'
@@ -13,8 +13,8 @@ description = 'Spring Data Redis'
group = 'org.springframework.data'
repositories {
- maven { url "http://repo.springsource.org/libs-snapshot" }
- maven { url "http://repo.springsource.org/plugins-release" }
+ maven { url "http://repo.spring.io/libs-snapshot" }
+ maven { url "http://repo.spring.io/plugins-release" }
mavenCentral()
}
@@ -112,8 +112,8 @@ jar {
manifest.attributes["Created-By"] = "${System.getProperty("java.version")} (${System.getProperty("java.specification.vendor")})"
manifest.attributes['Implementation-Title'] = 'spring-data-redis'
manifest.attributes['Implementation-Version'] = project.version
- manifest.attributes['Implementation-URL'] = "http://www.springsource.org/spring-data/redis"
- manifest.attributes['Implementation-Vendor'] = "SpringSource"
+ manifest.attributes['Implementation-URL'] = "http://projects.spring.io/spring-data-redis"
+ manifest.attributes['Implementation-Vendor'] = "Pivotal Software, Inc."
manifest.attributes['Implementation-Vendor-Id'] = "org.springframework"
from("$rootDir/docs/src/info") {
@@ -16,7 +16,7 @@
<p>
If you are interested in commercial training, consultancy and
support for the Spring Data Framework,
- <a href="http://www.SpringSource.com/" target="_top">SpringSource</a> provides
+ <a href="http://www.gopivotal.com/" target="_top">Pivotal Software, Inc.</a> provides
such commercial support.
</p>
</div>
@@ -1,8 +1,8 @@
SPRING DATA REDIS INTEGRATION CHANGELOG
=======================================
-http://www.springsource.org/spring-data/redis
+http://projects.spring.io/spring-data-redis/
-Commit changelog: http://github.com/SpringSource/spring-data-redis/tree/v[version]
+Commit changelog: http://github.com/spring-projects/spring-data-redis/tree/v[version]
Issues changelog: http://jira.springsource.org/secure/ReleaseNote.jspa?projectId=10604
Changes in version 1.1.0.RELEASE (2013-09-09)
View
@@ -1,6 +1,6 @@
SPRING DATA REDIS
-----------------
-http://www.springsource.org/spring-data/redis
+http://projects.spring.io/spring-data-redis/
1. INTRODUCTION
@@ -20,9 +20,9 @@ The Spring Data Redis jars files can be found in the 'dist' directory.
4. GETTING STARTED
Please see the reference documentation.
-Additionally the blog at http://blog.springsource.com as well as sections of interest in the reference documentation.
+Additionally the blog at https://spring.io/blog as well as sections of interest in the reference documentation.
ADDITIONAL RESOURCES
Spring Data Homepage: http://projects.spring.io/spring-data-redis/
-Spring Data Forum : http://forum.springsource.org/forumdisplay.php?f=80
+Spring Data Forum : http://forum.spring.io/forum/spring-projects/data/nosql
Redis Homepage : http://redis.io
@@ -21,10 +21,15 @@
<surname>Hickey</surname>
<affiliation>SpringSource</affiliation>
</author>
- <author>
+ <author>
<firstname>Christoph</firstname>
<surname>Strobl</surname>
- <affiliation>Pivotal</affiliation>
+ <affiliation>Pivotal Software, Inc.</affiliation>
+ </author>
+ <author>
+ <firstname>Thomas</firstname>
+ <surname>Darimont</surname>
+ <affiliation>Pivotal Software, Inc.</affiliation>
</author>
</authorgroup>
@@ -17,15 +17,15 @@
<section id="get-started:first-steps:spring">
<title>Knowing Spring</title>
- <para>Spring Data uses heavily Spring framework's <ulink url="http://static.springframework.org/spring/docs/3.0.x/reference/spring-core.html">core</ulink> functionality,
- such as the <ulink url="http://static.springframework.org/spring/docs/3.0.x/reference/beans.html">IoC</ulink> container,
- <ulink url="http://static.springframework.org/spring/docs/3.0.x/reference/resources.html">resource</ulink> abstract or
- <ulink url="http://static.springframework.org/spring/docs/3.0.x/reference/aop.html">AOP</ulink> infrastructure. While it is not important
+ <para>Spring Data uses heavily Spring framework's <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/spring-core.html">core</ulink> functionality,
+ such as the <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/beans.html">IoC</ulink> container,
+ <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html">resource</ulink> abstract or
+ <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/aop.html">AOP</ulink> infrastructure. While it is not important
to know the Spring APIs, understanding the concepts behind them is. At a minimum, the idea behind IoC should be familiar.
That being said, the more knowledge one has about the Spring, the faster she will pick up Spring Data Redis.
Besides the very comprehensive (and sometimes disarming) documentation that explains in detail the Spring Framework,
- there are a lot of articles, blog entries and books on the matter - take a look at the Spring framework
- <ulink url="http://www.springsource.org/documentation">home page</ulink> for more information. In general, this should be the starting point for
+ there are a lot of articles, blog entries and books on the matter - take a look at the Spring Guides
+ <ulink url="http://spring.io/guides">home page</ulink> for more information. In general, this should be the starting point for
developers wanting to try Spring DR.</para>
</section>
<section id="get-started:first-steps:nosql">
@@ -40,7 +40,7 @@
<section id="get-started:first-steps:samples">
<title>Trying Out The Samples</title>
<para>One can find various samples for key value stores in the dedicated example repo, at
- <ulink url="https://github.com/SpringSource/spring-data-keyvalue-examples">http://github.com/SpringSource/spring-data-keyvalue-examples</ulink>. For Spring Data Redis,
+ <ulink url="https://github.com/spring-projects/spring-data-keyvalue-examples">http://github.com/spring-projects/spring-data-keyvalue-examples</ulink>. For Spring Data Redis,
of interest is the <literal>retwisj</literal> sample, a Twitter-clone built on top of Redis which can be run locally or be deployed into the cloud. See its
<ulink url="http://static.springsource.org/spring-data/data-keyvalue/examples/retwisj/current/">documentation</ulink>, the following blog
<ulink url="http://blog.springsource.com/2011/04/27/getting-started-redis-spring-cloud-foundry/">entry</ulink> or the
@@ -55,13 +55,13 @@
<section id="get-started:help:community">
<title>Community Support</title>
- <para>The Spring Data <ulink url="http://forum.springframework.org/forumdisplay.php?f=80">forum</ulink> is a message board for all Spring Data (not just Redis) users to
+ <para>The Spring Data <ulink url="http://forum.spring.io/forum/spring-projects/data/nosql">forum</ulink> is a message board for all Spring Data (not just Redis) users to
share information and help each other. Note that registration is needed <emphasis>only</emphasis> for posting.
</para>
</section>
<section id="get-started:help:professional">
<title>Professional Support</title>
- <para>Professional, from-the-source support, with guaranteed response time, is available from <ulink url="http://www.springsource.com">SpringSource</ulink>,
+ <para>Professional, from-the-source support, with guaranteed response time, is available from <ulink url="http://www.gopivotal.com/">Pivotal Software, Inc.</ulink>,
the company behind Spring Data and Spring.
</para>
</section>
@@ -71,16 +71,16 @@
<title>Following Development</title>
<para>For information on the Spring Data source code repository, nightly builds and snapshot artifacts please see the Spring Data home
- <ulink url="http://www.springsource.org/spring-data">page</ulink>.
+ <ulink url="http://spring.io/spring-data">page</ulink>.
</para>
<para>You can help make Spring Data best serve the needs of the Spring community by interacting with developers through the Spring Community
- <ulink url="http://forum.springsource.org">forums</ulink>.</para>
+ <ulink url="http://forum.spring.io/">forums</ulink>.</para>
<para>If you encounter a bug or want to suggest an improvement,
please create a ticket on the Spring Data issue <ulink url="https://jira.springsource.org/browse/DATAREDIS">tracker</ulink>.</para>
<para>To stay up to date with the latest news and announcements in the Spring eco system, subscribe to the
- Spring Community <ulink url="http://www.springframework.org/">Portal</ulink>.</para>
- <para>Lastly, you can follow the SpringSource Data <ulink url="http://blog.springsource.com/category/data-access/">blog</ulink> or the project team on Twitter
- (<ulink url="http://twitter.com/jencompgeek">Jennifer</ulink>)</para>
+ Spring Community <ulink url="http://spring.io/">Portal</ulink>.</para>
+ <para>Lastly, you can follow the Spring <ulink url="http://spring.io/blog/">blog</ulink> or the project team (<ulink url="http://twitter.com/thomasdarimont ">Thomas</ulink> and <ulink url="http://twitter.com/stroblchristoph">Christoph</ulink>) on Twitter.
+ </para>
</section>
</chapter>
@@ -2,8 +2,8 @@
<title>Requirements</title>
<para>Spring Data Redis 1.2.x binaries requires JDK level 6.0 and above,
- and <ulink url="http://www.springsource.org/documentation">Spring Framework</ulink>
- 3.2.7 and above.</para>
+ and <ulink url="http://projects.spring.io/spring-framework/">Spring Framework</ulink>
+ 3.2.8 and above.</para>
<para>
In terms of key value stores, <ulink url="http://redis.io">Redis</ulink> 2.6.x or higher
is required. Spring Data Redis is currently tested against the latest 2.6 and 2.8 releases.
@@ -36,7 +36,7 @@
<xref linkend="redis:template"/> explains the abstraction built on top of the low-level <interfacename>Connection</interfacename> API to handle the
infrastructural concerns and object conversion.</listitem>
<listitem><emphasis>Support Classes</emphasis> - that offer reusable components (built on the aforementioned abstractions) such as
- <interfacename>java.util.Collection</interfacename> or Spring 3.1 <ulink url="http://blog.springsource.com/2011/02/23/spring-3-1-m1-caching/">cache</ulink> implementation backed by
+ <interfacename>java.util.Collection</interfacename> or Spring <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/cache.html">cache</ulink> implementation backed by
Redis as documented in <xref linkend="redis:support"/></listitem>
</itemizedlist>
@@ -58,7 +58,7 @@
<para><interfacename>RedisConnection</interfacename> provides the building block for Redis communication as it handles the communication with the Redis back-end.
It also automatically translates the underlying connecting library exceptions to Spring's consistent DAO exception
- <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/dao.html#dao-exceptions">hierarchy</ulink> so one can switch the connectors
+ <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/dao.html#dao-exceptions">hierarchy</ulink> so one can switch the connectors
without any code changes as the operation semantics remain the same.</para>
<note>For the corner cases where the native library API is required, <interfacename>RedisConnection</interfacename> provides a dedicated method
@@ -67,7 +67,7 @@
<para>Active <interfacename>RedisConnection</interfacename>s are created through <interfacename>RedisConnectionFactory</interfacename>. In addition, the factories act as
<interfacename>PersistenceExceptionTranslator</interfacename>s, meaning once declared, they allow one to do transparent exception translation. For example, exception translation through the use of the
<literal>@Repository</literal> annotation and AOP. For more information see the dedicated
- <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/orm.html#orm-exception-translation">section</ulink> in Spring Framework documentation.</para>
+ <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/orm.html#orm-exception-translation">section</ulink> in Spring Framework documentation.</para>
<note>Depending on the underlying configuration, the factory can return a new connection or an existing connection (in case a pool or shared native connection is used).</note>
</section>
@@ -394,7 +394,7 @@
(package <literal>org.springframework.data.redis.serializer</literal>) which as the name implies, takes care of the serialization process. Multiple implementations are
available out of the box, two of which have been already mentioned before in this documentation: the <literal>StringRedisSerializer</literal> and
the <literal>JdkSerializationRedisSerializer</literal>. However one can use <classname>OxmSerializer</classname> for Object/XML mapping through Spring 3
- <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/oxm.html">OXM</ulink> support or either <classname>JacksonJsonRedisSerializer</classname> or
+ <ulink url="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/oxm.html">OXM</ulink> support or either <classname>JacksonJsonRedisSerializer</classname> or
<classname>Jackson2JsonRedisSerializer</classname> for storing data in <ulink url="http://en.wikipedia.org/wiki/JSON">JSON</ulink> format. Do note that the storage format is not limited only to values - it can be used for keys, values or hashes
without any restrictions.</para>
</section>
Oops, something went wrong.

0 comments on commit 3a49fd1

Please sign in to comment.