Skip to content

Commit ed1cbbc

Browse files
committed
HSEARCH-4779 Reference the Hibernate Search 6.0 migration guide from the reference documentation and migration guide
1 parent bc26018 commit ed1cbbc

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

documentation/src/main/asciidoc/migration/index.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,19 @@ If you're looking to migrate from an earlier version,
2222
you should migrate step-by-step, from one minor version to the next,
2323
following the migration guide of link:https://hibernate.org/search/documentation/[each version].
2424

25+
[WARNING]
26+
====
27+
**To Hibernate Search 5 users**
28+
29+
Be aware that a lot of APIs have changed since Hibernate Search 5, some only because of a package change,
30+
others because of more fundamental changes
31+
(like moving away from using Lucene types in Hibernate Search APIs).
32+
33+
When migrating from Hibernate Search 5, you are encouraged to migrate first to Hibernate Search 6.0
34+
using the https://docs.jboss.org/hibernate/search/6.0/migration/html_single/[6.0 migration guide],
35+
and only then to later versions (which will be significantly easier).
36+
====
37+
2538
[[requirements]]
2639
== Requirements
2740

documentation/src/main/asciidoc/reference/getting-started.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,12 @@ most of the artifact IDs changed to reflect the new mapper/backend design,
8383
and the Lucene integration now requires an explicit dependency instead of being available by default.
8484
Read <<gettingstarted-dependencies>> for more information.
8585
86-
Additionally, be aware that a lot of APIs changed, some only because of a package change,
86+
Additionally, be aware that a lot of APIs have changed, some only because of a package change,
8787
others because of more fundamental changes
8888
(like moving away from using Lucene types in Hibernate Search APIs).
89+
For that reason, you are encouraged to migrate first to Hibernate Search 6.0
90+
using the https://docs.jboss.org/hibernate/search/6.0/migration/html_single/[6.0 migration guide],
91+
and only then to later versions (which will be significantly easier).
8992
====
9093

9194
[[gettingstarted-framework]]

0 commit comments

Comments
 (0)