DATAREDIS-825 - Polishing.

Fix typos. Remove redundant mention of JDK requirements.

Original pull request: #331.

Author: mp911de

src/main/asciidoc/appendix/appendix-schema.adoc

@@ -1,11 +1,5 @@
 [[appendix:schema]]
 [appendix]
 = Schema
-:resourcesDir: ../../resources
 
-== Core Schema
-
-[source,xml]
--------------------------------------------
-include::{resourcesDir}/org/springframework/data/redis/config/spring-redis-1.0.xsd[]
--------------------------------------------
+link:http://www.springframework.org/schema/redis/spring-redis-1.0.xsd[Spring Data Redis Schema (redis-namespace)]

src/main/asciidoc/index.adoc

@@ -2,7 +2,8 @@
 Costin Leau, Jennifer Hickey, Christoph Strobl, Thomas Darimont, Mark Paluch, Jay Bryant
 :revnumber: {version}
 :revdate: {localdate}
-:toc: left
+:toc:
+:toc-placement!:
 :spring-data-commons-include: ../../../../spring-data-commons/src/main/asciidoc
 :spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc
 
@@ -13,29 +14,40 @@ NOTE: Copies of this document may be made for your own use and for distribution
 toc::[]
 
 include::preface.adoc[]
+
 :leveloffset: +1
 include::new-features.adoc[]
+
 :leveloffset: -1
 
 [[introduction]]
 = Introduction
 
 :leveloffset: +1
 include::introduction/introduction.adoc[]
+
 include::introduction/why-sdr.adoc[]
+
 include::introduction/requirements.adoc[]
+
 include::introduction/getting-started.adoc[]
+
 :leveloffset: -1
 
 [[reference]]
 = Reference Documentation
 
 :leveloffset: +1
 include::reference/introduction.adoc[]
+
 include::reference/redis.adoc[]
+
 include::reference/reactive-redis.adoc[]
+
 include::reference/redis-cluster.adoc[]
+
 include::reference/redis-repositories.adoc[]
+
 :leveloffset: -1
 
 [[appendixes]]
@@ -44,6 +56,9 @@ include::reference/redis-repositories.adoc[]
 :numbered!:
 :leveloffset: +1
 include::appendix/introduction.adoc[]
+
 include::appendix/appendix-schema.adoc[]
+
 include::appendix/appendix-command-reference.adoc[]
+
 :leveloffset: -1

src/main/asciidoc/introduction/getting-started.adoc

@@ -21,7 +21,7 @@ NoSQL stores have taken the storage world by storm. It is a vast domain with a p
 [[get-started:first-steps:samples]]
 === Trying out the Samples
 
-One can find various samples for key-value stores in the dedicated Spring Data example repo, at https://github.com/spring-projects/spring-data-keyvalue-examples[http://github.com/spring-projects/spring-data-keyvalue-examples]. For Spring Data Redis, you should pay particular attention to the `retwisj` sample, a Twitter-clone built on top of Redis that can be run locally or be deployed into the cloud. See its http://static.springsource.org/spring-data/data-keyvalue/examples/retwisj/current/[documentation], the following blog http://blog.springsource.com/2011/04/27/getting-started-redis-spring-cloud-foundry/[entry] or the http://retwisj.cloudfoundry.com/[live instance] for more information.
+One can find various samples for key-value stores in the dedicated Spring Data example repo, at https://github.com/spring-projects/spring-data-keyvalue-examples[http://github.com/spring-projects/spring-data-keyvalue-examples]. For Spring Data Redis, you should pay particular attention to the `retwisj` sample, a Twitter-clone built on top of Redis that can be run locally or be deployed into the cloud. See its http://static.springsource.org/spring-data/data-keyvalue/examples/retwisj/current/[documentation], the following blog http://blog.springsource.com/2011/04/27/getting-started-redis-spring-cloud-foundry/[entry] for more information.
 
 [[get-started:help]]
 == Need Help?
@@ -46,7 +46,7 @@ For information on the Spring Data source code repository, nightly builds, and s
 You can help make Spring Data best serve the needs of the Spring community by interacting with developers on Stack Overflow at either
 http://stackoverflow.com/questions/tagged/spring-data[spring-data] or http://stackoverflow.com/questions/tagged/spring-data-redis[spring-data-redis].
 
-If you encounter a bug or want to suggest an improvement (including to this documentation), please create a ticket on the Spring Data issue https://jira.springsource.org/browse/DATAREDIS[tracker].
+If you encounter a bug or want to suggest an improvement (including to this documentation), please create a ticket on the Spring Data issue https://jira.spring.io/browse/DATAREDIS[tracker].
 
 To stay up to date with the latest news and announcements in the Spring eco system, subscribe to the Spring Community http://spring.io/[Portal].
 

src/main/asciidoc/introduction/requirements.adoc

@@ -1,6 +1,6 @@
 [[requirements]]
 = Requirements
 
-Spring Data Redis 1.x binaries require JDK level 6.0 and above and http://projects.spring.io/spring-framework/[Spring Framework] {springVersion} and above.
+Spring Data Redis 2.x binaries require JDK level 8.0 and above and http://projects.spring.io/spring-framework/[Spring Framework] {springVersion} and above.
 
-In terms of key-value stores, http://redis.io[Redis] 2.6.x or higher is required. Spring Data Redis is currently tested against the latest 3.2 release.
+In terms of key-value stores, http://redis.io[Redis] 2.6.x or higher is required. Spring Data Redis is currently tested against the latest 4.0 release.

src/main/asciidoc/reference/reactive-redis.adoc

@@ -7,7 +7,7 @@ This section covers reactive Redis support and how to get started. Reactive Redi
 [[redis:reactive:requirements]]
 == Redis Requirements
 
-Spring Data Redis requires Redis 2.6 or above and Java SE 8.0 or above. In terms of language bindings (or connectors), Spring Data Redis currently integrates with http://github.com/lettuce-io/lettuce-core[Lettuce] as the only reactive Java connector. https://projectreactor.io/[Project Reactor] is used as reactive composition library.
+Spring Data Redis currently integrates with http://github.com/lettuce-io/lettuce-core[Lettuce] as the only reactive Java connector. https://projectreactor.io/[Project Reactor] is used as reactive composition library.
 
 [[redis:reactive:connectors]]
 == Connecting to Redis by Using a Reactive Driver
@@ -46,7 +46,7 @@ public ReactiveRedisConnectionFactory connectionFactory() {
 }
 ----
 
-The following exxample shows a more sophisticated configuration, including SSL and timeouts, that uses `LettuceClientConfigurationBuilder`:
+The following example shows a more sophisticated configuration, including SSL and timeouts, that uses `LettuceClientConfigurationBuilder`:
 
 [source,java]
 ----

src/main/asciidoc/reference/redis-cluster.adoc

@@ -131,9 +131,9 @@ redis-cli@127.0.0.1:7379 > cluster nodes
 ----
 RedisClusterConnection connection = connectionFactory.getClusterConnnection();
 
-connection.set("thing1", value);         // slot: 12182
-connection.set("{thing1}.thing2", value);   // slot: 12182
-connection.set("thing2", value);         // slot:  5461
+connection.set("thing1", value);           // slot: 12182
+connection.set("{thing1}.thing2", value);  // slot: 12182
+connection.set("thing2", value);           // slot:  5461
 
 connection.mGet("thing1", "{thing1}.thing2");                                  <2>
 
@@ -148,7 +148,7 @@ connection.mGet("thing1", "thing2");                                           <
 
 TIP: The preceding examples demonstrate the general strategy followed by Spring Data Redis. Be aware that some operations might require loading huge amounts of data into memory to compute the desired command. Additionally, not all cross-slot requests can safely be ported to multiple single slot requests and error if misused (for example, `PFCOUNT`).
 
-== Working with RedisTemplate and ClusterOperations
+== Working with `RedisTemplate` and `ClusterOperations`
 
 See the <<redis:template>> section for information about the general purpose, configuration, and usage of `RedisTemplate`.
 

src/main/asciidoc/reference/redis-messaging.adoc

@@ -1,5 +1,5 @@
 [[pubsub]]
-= Redis Messaging and Pub/Sub
+= Redis Messaging (Pub/Sub)
 
 Spring Data provides dedicated messaging integration for Redis, similar in functionality and naming to the JMS integration in Spring Framework.
 
@@ -13,7 +13,7 @@ This is an example of the pattern often called Publish/Subscribe (Pub/Sub for sh
 The `org.springframework.data.redis.connection` and `org.springframework.data.redis.listener` packages provide the core functionality for Redis messaging.
 
 [[redis:pubsub:publish]]
-== Publishing or Sending Messages
+== Publishing (Sending Messages)
 
 To publish a message, you can use, as with the other operations, either the low-level `RedisConnection` or the high-level `RedisTemplate`. Both entities offer the `publish` method, which accepts the message and the destination channel as arguments. While `RedisConnection` requires raw data (array of bytes), the `RedisTemplate` lets arbitrary objects be passed in as messages, as shown in the following example:
 
@@ -28,7 +28,7 @@ template.convertAndSend("hello!", "world");
 ----
 
 [[redis:pubsub:subscribe]]
-== Subscribing to or Receiving Messages
+== Subscribing (Receiving Messages)
 
 On the receiving side, one can subscribe to one or multiple channels either by naming them directly or by using pattern matching. The latter approach is quite useful, as it not only lets multiple subscriptions be created with one command but can also listen on channels not yet created at subscription time (as long as they match the pattern).
 
@@ -49,8 +49,8 @@ Due to its blocking nature, low-level subscription is not attractive, as it requ
 
 Furthermore, to minimize the application footprint, `RedisMessageListenerContainer` lets one connection and one thread be shared by multiple listeners even though they do not share a subscription. Thus, no matter how many listeners or channels an application tracks, the runtime cost remains the same throughout its lifetime. Moreover, the container allows runtime configuration changes so that you can add or remove listeners while an application is running without the need for a restart. Additionally, the container uses a lazy subscription approach, using a `RedisConnection` only when needed. If all the listeners are unsubscribed, cleanup is automatically performed, and the thread is released.
 
-To help with the asynchronous nature of messages, the container requires a `java.util.concurrent.Executor` ( or Spring's `TaskExecutor`) for dispatching the messages. Depending on the load, the number of listeners, or the runtime environment, you should change or tweak the executor to better serve your needs. In particular, in managed environments (such as app servers), it is  highly recommended to pick a proper `TaskExecutor` to take advantage of its runtime.
-// TODO How can one know which is "proper"?
+To help with the asynchronous nature of messages, the container requires a `java.util.concurrent.Executor` (or Spring's `TaskExecutor`) for dispatching the messages. Depending on the load, the number of listeners, or the runtime environment, you should change or tweak the executor to better serve your needs. In particular, in managed environments (such as app servers), it is  highly recommended to pick a proper `TaskExecutor` to take advantage of its runtime.
+
 
 [[redis:pubsub:subscribe:adapter]]
 === The MessageListenerAdapter

src/main/asciidoc/reference/redis-repositories.adoc

@@ -14,7 +14,7 @@ Spring Data Redis lets you easily implement domain entities, as shown in the fol
 ====
 [source,java]
 ----
-@RedisHash("persons")
+@RedisHash("people")
 public class Person {
 
   @Id String id;
@@ -88,15 +88,15 @@ public void basicCrudOperations() {
   repo.delete(rand);                                       <4>
 }
 ----
-<1> Generates a new `id` if the current value is `null` or reuses an already set `id` value and stores properties of type `Person` inside the Redis Hash with a key that has a pattern of `keyspace:id` -- in this case, it might be `persons:5d67b7e1-8640-4475-beeb-c666fab4c0e5`.
+<1> Generates a new `id` if the current value is `null` or reuses an already set `id` value and stores properties of type `Person` inside the Redis Hash with a key that has a pattern of `keyspace:id` -- in this case, it might be `people:5d67b7e1-8640-4475-beeb-c666fab4c0e5`.
 <2> Uses the provided `id` to retrieve the object stored at `keyspace:id`.
-<3> Counts the total number of entities available within the keyspace, `persons`, defined by `@RedisHash` on `Person`.
+<3> Counts the total number of entities available within the keyspace, `people`, defined by `@RedisHash` on `Person`.
 <4> Removes the key for the given object from Redis.
 ====
 
 [[redis.repositories.mapping]]
 == Object-to-Hash Mapping
-The Redis Repository support persists Objects in Hashes. This requires an Object-to-Hash conversion which is done by a `RedisConverter`. The default implementation uses `Converter` for mapping property values to and from Redis native `byte[]`.
+The Redis Repository support persists Objects to Hashes. This requires an Object-to-Hash conversion which is done by a `RedisConverter`. The default implementation uses `Converter` for mapping property values to and from Redis native `byte[]`.
 
 Given the `Person` type from the previous sections, the default mapping looks like the following:
 
@@ -338,7 +338,7 @@ public class ApplicationConfig {
 
     @Override
     protected Iterable<KeyspaceSettings> initialConfiguration() {
-      return Collections.singleton(new KeyspaceSettings(Person.class, "persons"));
+      return Collections.singleton(new KeyspaceSettings(Person.class, "people"));
     }
   }
 }
@@ -368,7 +368,7 @@ public class ApplicationConfig {
 
     @Override
     protected Iterable<KeyspaceSettings> initialConfiguration() {
-      return Collections.singleton(new KeyspaceSettings(Person.class, "persons"));
+      return Collections.singleton(new KeyspaceSettings(Person.class, "people"));
     }
   }
 }
@@ -388,7 +388,7 @@ Given the sample `Person` entity shown earlier, we can create an index for `firs
 ====
 [source,java]
 ----
-@RedisHash("persons")
+@RedisHash("people")
 public class Person {
 
   @Id String id;
@@ -404,8 +404,8 @@ Indexes are built up for actual property values. Saving two Persons (for example
 ====
 [source,text]
 ----
-SADD persons:firstname:rand e2c7dcee-b8cd-4424-883e-736ce564363e
-SADD persons:firstname:aviendha a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56
+SADD people:firstname:rand e2c7dcee-b8cd-4424-883e-736ce564363e
+SADD people:firstname:aviendha a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56
 ----
 ====
 
@@ -414,7 +414,7 @@ It is also possible to have indexes on nested elements. Assume `Address` has a `
 ====
 [source,text]
 ----
-SADD persons:address.city:tear e2c7dcee-b8cd-4424-883e-736ce564363e
+SADD people:address.city:tear e2c7dcee-b8cd-4424-883e-736ce564363e
 ----
 ====
 
@@ -423,7 +423,7 @@ Furthermore, the programmatic setup lets you define indexes on map keys and list
 ====
 [source,java]
 ----
-@RedisHash("persons")
+@RedisHash("people")
 public class Person {
 
   // ... other properties omitted
@@ -433,9 +433,9 @@ public class Person {
   List<Address> addresses;            <3>
 }
 ----
-<1> `SADD persons:attributes.map-key:map-value e2c7dcee-b8cd-4424-883e-736ce564363e`
-<2> `SADD persons:relatives.map-key.firstname:tam e2c7dcee-b8cd-4424-883e-736ce564363e`
-<3> `SADD persons:addresses.city:tear e2c7dcee-b8cd-4424-883e-736ce564363e`
+<1> `SADD people:attributes.map-key:map-value e2c7dcee-b8cd-4424-883e-736ce564363e`
+<2> `SADD people:relatives.map-key.firstname:tam e2c7dcee-b8cd-4424-883e-736ce564363e`
+<3> `SADD people:addresses.city:tear e2c7dcee-b8cd-4424-883e-736ce564363e`
 ====
 
 CAUTION: Indexes cannot be resolved on <<redis.repositories.references,References>>.
@@ -456,7 +456,7 @@ public class ApplicationConfig {
 
     @Override
     protected Iterable<IndexDefinition> initialConfiguration() {
-      return Collections.singleton(new SimpleIndexDefinition("persons", "firstname"));
+      return Collections.singleton(new SimpleIndexDefinition("people", "firstname"));
     }
   }
 }
@@ -486,7 +486,7 @@ public class ApplicationConfig {
 
     @Override
     protected Iterable<IndexDefinition> initialConfiguration() {
-      return Collections.singleton(new SimpleIndexDefinition("persons", "firstname"));
+      return Collections.singleton(new SimpleIndexDefinition("people", "firstname"));
     }
   }
 }
@@ -501,7 +501,7 @@ Assume the `Address` type contains a `location` property of type `Point` that ho
 ====
 [source,java]
 ----
-@RedisHash("persons")
+@RedisHash("people")
 public class Person {
 
   Address address;
@@ -529,10 +529,10 @@ repository.save(rand);                                                        <3
 
 repository.findByAddressLocationNear(new Point(15D, 37D), new Distance(200)); <4>
 ----
-<1> Query method declaration on a nested property, using Point and Distance.
-<2> Query method declaration on a nested property, using Circle to search within.
-<3> `GEOADD persons:address:location 13.361389 38.115556 e2c7dcee-b8cd-4424-883e-736ce564363e`
-<4> `GEORADIUS persons:address:location 15.0 37.0 200.0 km`
+<1> Query method declaration on a nested property, using `Point` and `Distance`.
+<2> Query method declaration on a nested property, using `Circle` to search within.
+<3> `GEOADD people:address:location 13.361389 38.115556 e2c7dcee-b8cd-4424-883e-736ce564363e`
+<4> `GEORADIUS people:address:location 15.0 37.0 200.0 km`
 ====
 
 In the preceding example the, longitude and latitude values are stored by using `GEOADD` that use the object's `id` as the member's name. The finder methods allow usage of `Circle` or `Point, Distance` combinations for querying those values.
@@ -586,7 +586,7 @@ The `RedisKeyExpiredEvent` holds a copy of the expired domain object as well as
 
 NOTE: Delaying or disabling the expiry event listener startup impacts `RedisKeyExpiredEvent` publishing. A disabled event listener does not publish expiry events. A delayed startup can cause loss of events because of the delayed listener initialization.
 
-NOTE: The keyspace notification message listener alters `notify-keyspace-events` settings in Redis, if those are not already set. Existing settings are not overridden, so you must set up those settings correctly (or leav them empty). Note that `CONFIG` is disabled on AWS ElastiCache, and enabling the listener leads to an error.
+NOTE: The keyspace notification message listener alters `notify-keyspace-events` settings in Redis, if those are not already set. Existing settings are not overridden, so you must set up those settings correctly (or leave them empty). Note that `CONFIG` is disabled on AWS ElastiCache, and enabling the listener leads to an error.
 
 NOTE: Redis Pub/Sub messages are not persistent. If a key expires while the application is down, the expiry event is not processed, which may lead to secondary indexes containing references to the expired object.
 
@@ -603,7 +603,7 @@ _class = org.example.Person
 id = e2c7dcee-b8cd-4424-883e-736ce564363e
 firstname = rand
 lastname = al’thor
-mother = persons:a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56      <1>
+mother = people:a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56      <1>
 ----
 <1> Reference stores the whole key (`keyspace:id`) of the referenced object.
 ====
@@ -711,9 +711,9 @@ The following table shows the details of data on a cluster (based on previous ex
 [options = "header, autowidth"]
 |===============
 |Key|Type|Slot|Node
-|persons:e2c7dcee-b8cd-4424-883e-736ce564363e|id for hash|15171|127.0.0.1:7381
-|persons:a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56|id for hash|7373|127.0.0.1:7380
-|persons:firstname:rand|index|1700|127.0.0.1:7379
+|people:e2c7dcee-b8cd-4424-883e-736ce564363e|id for hash|15171|127.0.0.1:7381
+|people:a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56|id for hash|7373|127.0.0.1:7380
+|people:firstname:rand|index|1700|127.0.0.1:7379
 |
 |===============
 ====
@@ -723,14 +723,14 @@ Some commands (such as `SINTER` and `SUNION`) can only be processed on the serve
 [options = "header, autowidth"]
 |===============
 |Key|Type|Slot|Node
-|{persons}:e2c7dcee-b8cd-4424-883e-736ce564363e|id for hash|2399|127.0.0.1:7379
-|{persons}:a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56|id for hash|2399|127.0.0.1:7379
-|{persons}:firstname:rand|index|2399|127.0.0.1:7379
+|{people}:e2c7dcee-b8cd-4424-883e-736ce564363e|id for hash|2399|127.0.0.1:7379
+|{people}:a9d4b3a0-50d3-4538-a2fc-f7fc2581ee56|id for hash|2399|127.0.0.1:7379
+|{people}:firstname:rand|index|2399|127.0.0.1:7379
 |
 |===============
 ====
 
-TIP: Define and pin keyspaces by using `@RedisHash("{yourkeyspace}") to specific slots when you use Redis cluster.
+TIP: Define and pin keyspaces by using `@RedisHash("{yourkeyspace}")` to specific slots when you use Redis cluster.
 
 [[redis.repositories.cdi-integration]]
 == CDI Integration