Skip to content

Commit 3e7b1be

Browse files
authored
Add @UpdateForV9 for ReferenceDocs (elastic#123928) (elastic#123961)
The docs system is very different in v9 so we must update `ReferenceDocs` to generate links that are not broken.
1 parent 2b18a0c commit 3e7b1be

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

libs/core/src/main/java/org/elasticsearch/core/UpdateForV9.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ enum Owner {
2525
CORE_INFRA,
2626
DATA_MANAGEMENT,
2727
DISTRIBUTED_INDEXING,
28+
DOCS,
2829
ENTERPRISE_SEARCH,
2930
MACHINE_LEARNING,
3031
PROFILING,

server/src/main/java/org/elasticsearch/common/ReferenceDocs.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
import org.elasticsearch.Build;
1313
import org.elasticsearch.core.SuppressForbidden;
14+
import org.elasticsearch.core.UpdateForV9;
1415

1516
import java.io.BufferedReader;
1617
import java.io.FileNotFoundException;
@@ -27,6 +28,7 @@
2728
* {@link #toString()} yields (a string representation of) a URL for the relevant docs. Links are defined in the resource file
2829
* {@code reference-docs-links.txt} which must include definitions for exactly the set of values of this enum.
2930
*/
31+
@UpdateForV9(owner = UpdateForV9.Owner.DOCS) // the docs are completely different in v9 so these links all need fixing
3032
public enum ReferenceDocs {
3133
/*
3234
* Note that the docs subsystem parses {@code reference-docs-links.txt} differently. See {@code sub check_elasticsearch_links} in

0 commit comments

Comments
 (0)