Skip to content

Commit b721ce4

Browse files
committed
Replace news and noteworthy with links to the release notes.
Closes spring-projects#2453
1 parent 946a39e commit b721ce4

File tree

4 files changed

+31
-18
lines changed

4 files changed

+31
-18
lines changed

src/main/asciidoc/upgrading.adoc renamed to src/main/asciidoc/appendix/upgrading.adoc

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
[[upgrading]]
2-
= Upgrading
1+
[[redis.upgrading]]
2+
[appendix]
3+
= Migration Guides
34

45
This section contains details about migration steps, deprecations, and removals.
56

67
[[upgrading.2-to-3]]
78
== Upgrading from 2.x to 3.x
89

10+
[[upgrading.2-to-3.types]]
911
=== Re-/moved Types
1012

1113
|===
@@ -43,7 +45,7 @@ This section contains details about migration steps, deprecations, and removals.
4345

4446
|===
4547

46-
== Changed Methods and Types
48+
=== Changed Methods and Types
4749

4850
.Core
4951
|===
@@ -181,7 +183,10 @@ This section contains details about migration steps, deprecations, and removals.
181183

182184
|===
183185

184-
== Jedis
186+
[[upgrading.2-to-3.jedis]]
187+
=== Jedis
188+
189+
Please read the Jedis https://github.com/redis/jedis/blob/v4.0.0/docs/3to4.md[upgrading guide] which covers important driver changes.
185190

186191
.Jedis Redis Connection
187192
|===
@@ -237,25 +242,27 @@ This section contains details about migration steps, deprecations, and removals.
237242

238243
|===
239244

245+
[[upgrading.2-to-3.jedis.transactions]]
246+
=== Transactions / Pipelining
247+
248+
Pipelining and Transactions are now mutually exclusive.
249+
The usage of server or connection commands in pipeline/transactions mode is no longer possible.
250+
251+
[[upgrading.2-to-3.lettuce]]
240252
=== Lettuce
241253

254+
[[upgrading.2-to-3.lettuce.pool]]
242255
==== Lettuce Pool
243256

244257
`LettucePool` and its implementation `DefaultLettucePool` have been removed without replacement.
245258
Please refer to the https://lettuce.io/core/release/reference/index.html#_connection_pooling[driver documentation] for driver native pooling capabilities.
246259
Methods accepting pooling parameters have been updated.
247260
This effects methods on `LettuceConnectionFactory` and `LettuceConnection`.
248261

262+
[[upgrading.2-to-3.lettuce.authentication]]
249263
==== Lettuce Authentication
250264

251265
`AuthenticatingRedisClient` has been removed without replacement.
252266
Please refer to the https://lettuce.io/core/release/reference/index.html#basic.redisuri[driver documentation] for `RedisURI` to set authentication data.
253267

254-
== Jedis
255268

256-
Please read the Jedis https://github.com/redis/jedis/blob/v4.0.0/docs/3to4.md[upgrading guide] which covers important driver changes.
257-
258-
=== Transactions / Pipelining
259-
260-
Pipelining and Transactions are now mutually exclusive.
261-
The usage of server or connection commands in pipeline/transactions mode is no longer possible.

src/main/asciidoc/index.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ Costin Leau, Jennifer Hickey, Christoph Strobl, Thomas Darimont, Mark Paluch, Ja
33
:revnumber: {version}
44
:revdate: {localdate}
55
ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1600]]
6-
:spring-data-commons-include: ../../../../spring-data-commons/src/main/asciidoc
7-
:spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc
6+
:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc
87
:spring-framework-javadoc: https://docs.spring.io/spring-framework/docs/{springVersion}/javadoc-api
98
:spring-framework-reference: https://docs.spring.io/spring-framework/docs/{springVersion}/reference/html
109
:store: Redis
@@ -17,15 +16,13 @@ toc::[]
1716

1817
include::preface.adoc[]
1918

20-
include::upgrading.adoc[leveloffset=+1]
21-
22-
2319
include::{spring-data-commons-docs}/dependencies.adoc[leveloffset=+1]
2420

2521
[[reference]]
2622
= Reference Documentation
2723

2824
include::reference/introduction.adoc[leveloffset=+1]
25+
include::reference/upgrade.adoc[leveloffset=+1]
2926
include::reference/why-sdr.adoc[leveloffset=+1]
3027
include::reference/redis.adoc[leveloffset=+1]
3128
include::reference/observability.adoc[leveloffset=+1]
@@ -41,3 +38,4 @@ include::reference/redis-repositories.adoc[leveloffset=+1]
4138
include::appendix/introduction.adoc[leveloffset=+1]
4239
include::appendix/appendix-schema.adoc[leveloffset=+1]
4340
include::appendix/appendix-command-reference.adoc[leveloffset=+1]
41+
include::appendix/upgrading.adoc[leveloffset=+1]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public void basicCrudOperations() {
101101
<4> Removes the key for the given object from Redis.
102102
====
103103

104-
include::../{spring-data-commons-include}/object-mapping.adoc[leveloffset=+1]
104+
include::../{spring-data-commons-docs}/object-mapping.adoc[leveloffset=+1]
105105

106106
[[redis.repositories.mapping]]
107107
== Object-to-Hash Mapping
@@ -573,7 +573,7 @@ The finder methods allow usage of `Circle` or `Point, Distance` combinations for
573573

574574
NOTE: It is **not** possible to combine `near` and `within` with other criteria.
575575

576-
include::../{spring-data-commons-include}/query-by-example.adoc[leveloffset=+1]
576+
include::../{spring-data-commons-docs}/query-by-example.adoc[leveloffset=+1]
577577
include::query-by-example.adoc[leveloffset=+1]
578578

579579
[[redis.repositories.expirations]]
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
include::../{spring-data-commons-docs}/upgrade.adoc[]
2+
3+
== What to Read Next
4+
5+
Once you’ve decided to upgrade your application, you can find detailed information regarding specific features in the rest of the document.
6+
You can find <<redis.upgrading,migration guides>> specific to major version migrations at the end of this document.
7+
8+
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.

0 commit comments

Comments
 (0)