-
Notifications
You must be signed in to change notification settings - Fork 25.2k
Change allocation explain message #127060
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
Change allocation explain message #127060
Conversation
Reduce the amount of text returned when no shard is requested and all shards are assigned. Less text is easier to digest and hopefully will not be skimmed.
Pinging @elastic/es-distributed-coordination (Team:Distributed Coordination) |
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.
Ok by me, but I wonder, maybe we should just reverse the order so the next-steps instruction is first and then the context is second. Something like this:
Specify an assigned shard in the request body to explain its allocation. No shard was specified in the request which \
means to explain the allocation of a randomly-chosen unassigned shard, but there are no unassigned shards in this \
cluster. See %s for more information.""", ReferenceDocs.ALLOCATION_EXPLAIN_API));
That still keeps it relatively wordy. I'd actually like to move explanation (no pun intended 🙄) of the default behavior when no shard is specified to the public docs. Then the response is like 'hey, no unassigned like you wanted, but you can do this other thing'. I stole some of your new text, though: even more concise. |
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.
Seems worth a shot. It's basically a losing battle when folks don't read the message anyway...
Reduce the amount of text returned when no shard is requested and all
shards are assigned. Less text is easier to digest and hopefully will
not be skimmed.