HSEARCH-4375 Mark the outbox-polling coordination strategy as incubat…

…ing in the documentation
hibernate · Nov 30, 2021 · 0f6e9ee · 0f6e9ee
1 parent 16c80f3
commit 0f6e9ee
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/documentation/src/main/asciidoc/reference/architecture.asciidoc b/documentation/src/main/asciidoc/reference/architecture.asciidoc
@@ -242,6 +242,8 @@ To implement this architecture, use the following Maven dependencies:
 [[architecture-examples-outbox-polling-elasticsearch]]
 === [[_elasticsearch]] Multi-node application with outbox polling and Elasticsearch backend
 
+include::components/incubating-warning.asciidoc[]
+
 [[architecture-examples-outbox-polling-elasticsearch-description]]
 ==== [[architecture-examples-database-polling-elasticsearch-description]] Description
 

diff --git a/documentation/src/main/asciidoc/reference/components/incubating-warning.asciidoc b/documentation/src/main/asciidoc/reference/components/incubating-warning.asciidoc
@@ -3,7 +3,7 @@
 Features detailed in this section are _incubating_: they are still under active development.
 
 The usual https://hibernate.org/community/compatibility-policy/[compatibility policy] does not apply:
-the contract of incubating elements (e.g. types, methods etc.)
+the contract of incubating elements (e.g. types, methods, configuration properties, etc.)
 may be altered in a backward-incompatible way -- or even removed -- in subsequent releases.
 
 You are encouraged to use incubating features so the development team can get feedback and improve them,

diff --git a/documentation/src/main/asciidoc/reference/coordination.asciidoc b/documentation/src/main/asciidoc/reference/coordination.asciidoc
@@ -132,6 +132,8 @@ See <<mapper-orm-indexing-automatic-synchronization>> for details.
 [[coordination-outbox-polling]]
 == [[coordination-database-polling]] `outbox-polling`: additional event tables and polling in background processors
 
+include::components/incubating-warning.asciidoc[]
+
 [[coordination-outbox-polling-basics]]
 === [[coordination-database-polling-basics]] Basics
 

diff --git a/...ch/mapper/orm/coordination/outboxpolling/cfg/HibernateOrmMapperOutboxPollingSettings.java b/...ch/mapper/orm/coordination/outboxpolling/cfg/HibernateOrmMapperOutboxPollingSettings.java
@@ -7,7 +7,9 @@
 package org.hibernate.search.mapper.orm.coordination.outboxpolling.cfg;
 
 import org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public final class HibernateOrmMapperOutboxPollingSettings {
 
 	private HibernateOrmMapperOutboxPollingSettings() {