Skip to content

Add comment re. parsing of ReferenceDocs JSON #94794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2023
Merged

Add comment re. parsing of ReferenceDocs JSON #94794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions server/src/main/java/org/elasticsearch/common/ReferenceDocs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@
* {@code reference-docs-links.json} which must include definitions for exactly the set of values of this enum.
*/
public enum ReferenceDocs {
/*
* Note that the docs subsystem parses {@code reference-docs-links.json} with regexes, not a JSON parser, so the whitespace in the file
* is important too. See {@code sub check_elasticsearch_links} in {@code https://github.com/elastic/docs/blob/master/build_docs.pl} for
* more details.
*
* Also note that the docs are built from the HEAD of each minor release branch, so in principle docs can move around independently of
* the ES release process. To avoid breaking any links that have been baked into earlier patch releases, you may only add links in a
* patch release and must not modify or remove any existing links.
*/
INITIAL_MASTER_NODES,
DISCOVERY_TROUBLESHOOTING,
UNSTABLE_CLUSTER_TROUBLESHOOTING,
Expand Down