github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 23:27:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add @UpdateForV9 for ReferenceDocs (#123928)

Browse source 
The docs system is very different in v9 so we must update
`ReferenceDocs` to generate links that are not broken.
This commit is contained in:
David Turner 2025-03-04 07:38:20 +00:00 • committed by GitHub
parent 4f2f1bc2a7
commit 4e00998cf2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
libs/core/src/main/java/org/elasticsearch/core/UpdateForV9.java
View file

@ -25,6 +25,7 @@ public @interface UpdateForV9 {
CORE_INFRA, CORE_INFRA,
DATA_MANAGEMENT, DATA_MANAGEMENT,
DISTRIBUTED_INDEXING, DISTRIBUTED_INDEXING,
DOCS,
ENTERPRISE_SEARCH, ENTERPRISE_SEARCH,
MACHINE_LEARNING, MACHINE_LEARNING,
PROFILING, PROFILING,

2
server/src/main/java/org/elasticsearch/common/ReferenceDocs.java
View file

@ -11,6 +11,7 @@ package org.elasticsearch.common;
import org.elasticsearch.Build; import org.elasticsearch.Build;
import org.elasticsearch.core.SuppressForbidden; import org.elasticsearch.core.SuppressForbidden;
import org.elasticsearch.core.UpdateForV9;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
@ -27,6 +28,7 @@ import java.util.regex.Pattern;
* {@link #toString()} yields (a string representation of) a URL for the relevant docs. Links are defined in the resource file * {@link #toString()} yields (a string representation of) a URL for the relevant docs. Links are defined in the resource file
* {@code reference-docs-links.txt} which must include definitions for exactly the set of values of this enum. * {@code reference-docs-links.txt} which must include definitions for exactly the set of values of this enum.
*/ */
@UpdateForV9(owner = UpdateForV9.Owner.DOCS) // the docs are completely different in v9 so these links all need fixing
public enum ReferenceDocs { public enum ReferenceDocs {
/* /*
* Note that the docs subsystem parses {@code reference-docs-links.txt} differently. See {@code sub check_elasticsearch_links} in * Note that the docs subsystem parses {@code reference-docs-links.txt} differently. See {@code sub check_elasticsearch_links} in