WIP fix docs

quarkusio · Oct 10, 2024 · 44d8359 · 44d8359
1 parent f182fb0
commit 44d8359
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 4 deletions.
diff --git a/...rch/backend/elasticsearch/runtime/HibernateSearchBackendElasticsearchBuildTimeConfig.java b/...rch/backend/elasticsearch/runtime/HibernateSearchBackendElasticsearchBuildTimeConfig.java
@@ -97,20 +97,20 @@ interface SchemaManagementConfig {
     @ConfigGroup
     interface AnalysisConfig {
         /**
-         * One or more xref:#bean-reference-note-anchor[bean references]
+         * One or more xref:{quarkus-hibernate-search-docs-path}#bean-reference-note-anchor[bean references]
          * to the component(s) used to configure full text analysis (e.g. analyzers, normalizers).
          *
          * The referenced beans must implement `ElasticsearchAnalysisConfigurer`.
          *
-         * See xref:#analysis-configurer[Setting up the analyzers] for more
+         * See xref:{quarkus-hibernate-search-docs-path}#analysis-configurer[Setting up the analyzers] for more
          * information.
          *
          * [NOTE]
          * ====
          * Instead of setting this configuration property,
          * you can simply annotate your custom `ElasticsearchAnalysisConfigurer` implementations with `@SearchExtension`
          * and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
-         * See xref:#plugging-in-custom-components[this section]
+         * See xref:{quarkus-hibernate-search-docs-path}#plugging-in-custom-components[this section]
          * for more information.
          *
          * If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.

diff --git a/...earch/backend/elasticsearch/runtime/HibernateSearchBackendElasticsearchRuntimeConfig.java b/...earch/backend/elasticsearch/runtime/HibernateSearchBackendElasticsearchRuntimeConfig.java
@@ -338,7 +338,7 @@ interface LayoutConfig {
          * Instead of setting this configuration property,
          * you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
          * and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
-         * See xref:#plugging-in-custom-components[this section]
+         * See xref:{quarkus-hibernate-search-docs-path}#plugging-in-custom-components[this section]
          * for more information.
          *
          * If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.

diff --git a/...bernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchBuildTimeConfig.java b/...bernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchBuildTimeConfig.java
@@ -3,6 +3,7 @@
 import java.util.Map;
 
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
+import io.quarkus.runtime.annotations.ConfigDocAttribute;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
 import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigPhase;
@@ -14,6 +15,8 @@
 
 @ConfigMapping(prefix = "quarkus.hibernate-search-orm")
 @ConfigRoot(phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
+// Referenced in HibernateSearchBackendElasticsearchBuildTimeConfig
+@ConfigDocAttribute(name = "quarkus-hibernate-search-docs-path", value = "hibernate-search-orm-elasticsearch.adoc")
 public interface HibernateSearchElasticsearchBuildTimeConfig {
 
     /**

diff --git a/...hibernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchRuntimeConfig.java b/...hibernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchRuntimeConfig.java
@@ -4,6 +4,7 @@
 import java.util.Map;
 
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
+import io.quarkus.runtime.annotations.ConfigDocAttribute;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
@@ -13,6 +14,8 @@
 
 @ConfigMapping(prefix = "quarkus.hibernate-search-orm")
 @ConfigRoot(phase = ConfigPhase.RUN_TIME)
+// Referenced in HibernateSearchBackendElasticsearchRuntimeConfig
+@ConfigDocAttribute(name = "quarkus-hibernate-search-docs-path", value = "hibernate-search-orm-elasticsearch.adoc")
 public interface HibernateSearchElasticsearchRuntimeConfig {
 
     /**

diff --git a/...ate/search/standalone/elasticsearch/runtime/HibernateSearchStandaloneBuildTimeConfig.java b/...ate/search/standalone/elasticsearch/runtime/HibernateSearchStandaloneBuildTimeConfig.java
@@ -5,6 +5,7 @@
 import java.util.Optional;
 
 import io.quarkus.hibernate.search.backend.elasticsearch.runtime.HibernateSearchBackendElasticsearchBuildTimeConfig;
+import io.quarkus.runtime.annotations.ConfigDocAttribute;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
 import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigGroup;
@@ -17,6 +18,8 @@
 
 @ConfigMapping(prefix = "quarkus.hibernate-search-standalone")
 @ConfigRoot(phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
+// Referenced in HibernateSearchBackendElasticsearchBuildTimeConfig
+@ConfigDocAttribute(name = "quarkus-hibernate-search-docs-path", value = "hibernate-search-standalone-elasticsearch.adoc")
 public interface HibernateSearchStandaloneBuildTimeConfig {
 
     /**

diff --git a/...rnate/search/standalone/elasticsearch/runtime/HibernateSearchStandaloneRuntimeConfig.java b/...rnate/search/standalone/elasticsearch/runtime/HibernateSearchStandaloneRuntimeConfig.java
@@ -7,6 +7,7 @@
 import org.hibernate.search.mapper.pojo.standalone.schema.management.SchemaManagementStrategyName;
 
 import io.quarkus.hibernate.search.backend.elasticsearch.runtime.HibernateSearchBackendElasticsearchRuntimeConfig;
+import io.quarkus.runtime.annotations.ConfigDocAttribute;
 import io.quarkus.runtime.annotations.ConfigDocDefault;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
 import io.quarkus.runtime.annotations.ConfigDocSection;
@@ -20,6 +21,8 @@
 
 @ConfigMapping(prefix = "quarkus.hibernate-search-standalone")
 @ConfigRoot(phase = ConfigPhase.RUN_TIME)
+// Referenced in HibernateSearchBackendElasticsearchRuntimeConfig
+@ConfigDocAttribute(name = "quarkus-hibernate-search-docs-path", value = "hibernate-search-standalone-elasticsearch.adoc")
 public interface HibernateSearchStandaloneRuntimeConfig {
 
     /**