-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Reformats cat recovery API #45345
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.
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
Conversation
Pinging @elastic/es-docs |
Pinging @elastic/es-core-features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left one comment--not sure if the example is missing or was moved & the text needs to be updated accordingly.
As an example, here is what the recovery state of a cluster may look like when | ||
there are no shards in transit from one node to another: | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there an example missing here?
(I also twitch over "may" vs "might" ... I would reflexively use might because "may implies permission". But that's one of those editorial stickles where the distinction doesn't really matter to most readers.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching this @debadair. I intended to remove this sentence entirely. Removed with c7f88d6.
The example has been moved to https://github.com/elastic/elasticsearch/pull/45345/files#diff-0e907dfad62124d1dc58267b446d2c51R61
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR updates the cat recovery API to align with the new API reference template.
Relates to elastic/docs#937 and #45196
Preview
http://elasticsearch_45345.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/cat-recovery.html