[DOCS] Collapse contents in cluster reroute docs#54851
[DOCS] Collapse contents in cluster reroute docs#54851jrodewig merged 2 commits intoelastic:masterfrom
Conversation
|
Pinging @elastic/es-docs (>docs) |
|
@elasticmachine test this please |
| ===== | ||
| ==== |
There was a problem hiding this comment.
These block delimiters are unneeded and preventing the docs build from working properly.
| ===== | |
| ==== |
| .Properties of `metric` | ||
| [%collapsible%open] | ||
| ====== |
There was a problem hiding this comment.
Because these are query parameters, they're not objects per se. It's more accurate to describe them as `options.
I'm not sure we need the collapsible section here as these won't be nested more than one level deep.
| .Properties of `metric` | |
| [%collapsible%open] | |
| ====== | |
| .Options for `metric` | |
| [%collapsible%open] | |
| ====== |
| @@ -58,28 +58,30 @@ query parameter, which will attempt a single retry round for these shards. | |||
| ==== {api-query-parms-title} | |||
There was a problem hiding this comment.
| ==== {api-query-parms-title} | |
| [role="child_attributes"] | |
| ==== {api-query-parms-title} |
| `POST /_cluster/reroute` | ||
|
|
||
|
|
||
| [role="child_attributes"] |
There was a problem hiding this comment.
This attribute should be included in the sections containing the collapsible sections.
| [role="child_attributes"] |
| ===== | ||
| ==== |
There was a problem hiding this comment.
| ===== | |
| ==== |
| @@ -109,10 +114,13 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] | |||
| (Required, object) Defines the commands to perform. Supported commands are: | |||
There was a problem hiding this comment.
GitHub won't allow me to add a comment, but [role="child_attributes"] needs to added directly above ==== {api-request-body-title} or [[cluster-reroute-api-request-body]] around line 110.
| @@ -109,10 +114,13 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] | |||
| (Required, object) Defines the commands to perform. Supported commands are: | |||
There was a problem hiding this comment.
| (Required, object) Defines the commands to perform. Supported commands are: | |
| (Required, array of objects) Defines the commands to perform. Supported commands are: |
| for index name and shard number, and `node` to allocate the shard to. Takes | ||
| <<modules-cluster,allocation deciders>> into account. | ||
| -- | ||
| ====== |
There was a problem hiding this comment.
I would move this delimiter after the definition for allocate_empty_primary. allocate_stale_primary and allocate_empty_primary are properties for a commands object.
|
@elasticmachine test this please |
|
Thanks @jrodewig. This is my first open source pull request. Many more to go. |
|
Thanks for making us your first contribution, @patelvp! |
Summary
Collapsible docs for cluster reroute document as mentioned in #54667
Uses changes in elastic/docs#1786
Tests
Ran
./gradlew -p docs checktests pass.