Replace news and noteworthy with links to the release notes.

Closes #2453
This commit is contained in:
Mark Paluch
2022-11-11 10:20:08 +01:00
parent 946a39ecad
commit b721ce4023
4 changed files with 31 additions and 18 deletions

View File

@@ -1,11 +1,13 @@
[[upgrading]]
= Upgrading
[[redis.upgrading]]
[appendix]
= Migration Guides
This section contains details about migration steps, deprecations, and removals.
[[upgrading.2-to-3]]
== Upgrading from 2.x to 3.x
[[upgrading.2-to-3.types]]
=== Re-/moved Types
|===
@@ -43,7 +45,7 @@ This section contains details about migration steps, deprecations, and removals.
|===
== Changed Methods and Types
=== Changed Methods and Types
.Core
|===
@@ -181,7 +183,10 @@ This section contains details about migration steps, deprecations, and removals.
|===
== Jedis
[[upgrading.2-to-3.jedis]]
=== Jedis
Please read the Jedis https://github.com/redis/jedis/blob/v4.0.0/docs/3to4.md[upgrading guide] which covers important driver changes.
.Jedis Redis Connection
|===
@@ -237,8 +242,16 @@ This section contains details about migration steps, deprecations, and removals.
|===
[[upgrading.2-to-3.jedis.transactions]]
=== Transactions / Pipelining
Pipelining and Transactions are now mutually exclusive.
The usage of server or connection commands in pipeline/transactions mode is no longer possible.
[[upgrading.2-to-3.lettuce]]
=== Lettuce
[[upgrading.2-to-3.lettuce.pool]]
==== Lettuce Pool
`LettucePool` and its implementation `DefaultLettucePool` have been removed without replacement.
@@ -246,16 +259,10 @@ Please refer to the https://lettuce.io/core/release/reference/index.html#_connec
Methods accepting pooling parameters have been updated.
This effects methods on `LettuceConnectionFactory` and `LettuceConnection`.
[[upgrading.2-to-3.lettuce.authentication]]
==== Lettuce Authentication
`AuthenticatingRedisClient` has been removed without replacement.
Please refer to the https://lettuce.io/core/release/reference/index.html#basic.redisuri[driver documentation] for `RedisURI` to set authentication data.
== Jedis
Please read the Jedis https://github.com/redis/jedis/blob/v4.0.0/docs/3to4.md[upgrading guide] which covers important driver changes.
=== Transactions / Pipelining
Pipelining and Transactions are now mutually exclusive.
The usage of server or connection commands in pipeline/transactions mode is no longer possible.

View File

@@ -3,8 +3,7 @@ Costin Leau, Jennifer Hickey, Christoph Strobl, Thomas Darimont, Mark Paluch, Ja
:revnumber: {version}
:revdate: {localdate}
ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1600]]
: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
:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc
:spring-framework-javadoc: https://docs.spring.io/spring-framework/docs/{springVersion}/javadoc-api
:spring-framework-reference: https://docs.spring.io/spring-framework/docs/{springVersion}/reference/html
:store: Redis
@@ -17,15 +16,13 @@ toc::[]
include::preface.adoc[]
include::upgrading.adoc[leveloffset=+1]
include::{spring-data-commons-docs}/dependencies.adoc[leveloffset=+1]
[[reference]]
= Reference Documentation
include::reference/introduction.adoc[leveloffset=+1]
include::reference/upgrade.adoc[leveloffset=+1]
include::reference/why-sdr.adoc[leveloffset=+1]
include::reference/redis.adoc[leveloffset=+1]
include::reference/observability.adoc[leveloffset=+1]
@@ -41,3 +38,4 @@ include::reference/redis-repositories.adoc[leveloffset=+1]
include::appendix/introduction.adoc[leveloffset=+1]
include::appendix/appendix-schema.adoc[leveloffset=+1]
include::appendix/appendix-command-reference.adoc[leveloffset=+1]
include::appendix/upgrading.adoc[leveloffset=+1]

View File

@@ -101,7 +101,7 @@ public void basicCrudOperations() {
<4> Removes the key for the given object from Redis.
====
include::../{spring-data-commons-include}/object-mapping.adoc[leveloffset=+1]
include::../{spring-data-commons-docs}/object-mapping.adoc[leveloffset=+1]
[[redis.repositories.mapping]]
== Object-to-Hash Mapping
@@ -573,7 +573,7 @@ The finder methods allow usage of `Circle` or `Point, Distance` combinations for
NOTE: It is **not** possible to combine `near` and `within` with other criteria.
include::../{spring-data-commons-include}/query-by-example.adoc[leveloffset=+1]
include::../{spring-data-commons-docs}/query-by-example.adoc[leveloffset=+1]
include::query-by-example.adoc[leveloffset=+1]
[[redis.repositories.expirations]]

View File

@@ -0,0 +1,8 @@
include::../{spring-data-commons-docs}/upgrade.adoc[]
== What to Read Next
Once youve decided to upgrade your application, you can find detailed information regarding specific features in the rest of the document.
You can find <<redis.upgrading,migration guides>> specific to major version migrations at the end of this document.
Spring Data's documentation is specific to that version, so any information that you find in here will contain the most up-to-date changes that are in that version.