Add link to NO_COPIES allocation explain message #113656
Conversation
matthewabbott
added
>non-issue
:Distributed/Allocation
elasticsearchmachine
added
v9.0.0
external-contributor
matthewabbott
added
>docs
| @@ -29,10 +29,10 @@ public static final class Allocation { | |||
| will allocate this shard when a node containing a good copy of its data joins the cluster. If no such node is available, \ | |||
| restore this index from a recent snapshot."""; | |||
|
|
|||
| public static final String NO_COPIES = """ | |||
| public static final String NO_COPIES = String.format(""" | |||
There was a problem hiding this comment.
This API is forbidden - you forgot to run ./gradlew precommit before opening this.
| @@ -43,5 +43,6 @@ | |||
| "MAX_SHARDS_PER_NODE": "size-your-shards.html#troubleshooting-max-shards-open", | |||
| "FLOOD_STAGE_WATERMARK": "fix-watermark-errors.html", | |||
| "X_OPAQUE_ID": "api-conventions.html#x-opaque-id", | |||
| "FORMING_SINGLE_NODE_CLUSTERS": "modules-discovery-bootstrap-cluster.html#modules-discovery-bootstrap-cluster-joining" | |||
| "FORMING_SINGLE_NODE_CLUSTERS": "modules-discovery-bootstrap-cluster.html#modules-discovery-bootstrap-cluster-joining", | |||
| "ALLOCATION_EXPLAIN_NO_COPIES": "cluster-allocation-explain.html#_no_valid_shard_copy" | |||
There was a problem hiding this comment.
Please add a fixed [[anchor-name]] to the docs rather than using the #_auto-generated one that might change inadvertently.
There was a problem hiding this comment.
See #113667 which forbids this.
There was a problem hiding this comment.
@matthewabbott, elaborating ...
(I assume the way Dave knew the above was wrong is that auto-generated headers can break and prefix _ and join header words via _.) On this doc line, you'll want to prefix a line like this example. So we will be editing the *.asciidoc in this PR after all. Afterwards in the above, what you had set inside the square brackets like [[explain-no-valid-shard-copy]] will become what goes at the end of the URL cluster-allocation-explain.html#explain-no-valid-shard-copy.
Adds no_valid_shard_copies reference link to the NO_COPIES allocation explanations string