[DOCS] Clarify remote/info and resolve/cluster descriptions #3655
Conversation
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
| * as long as the networking layer is configured to wait for remote clusters that are | ||
| * not responding (typically 30 seconds). | ||
| */ | ||
| timeout?: Duration // default: unset |
There was a problem hiding this comment.
@lcawl - should I put "unset" here or just remove the // default comment altogether.
There was a problem hiding this comment.
The documentation doesn't reflect any comments like that, so it doesn't serve a purpose as far as I know.
For properties that have default values, @server_default xxx works for docs.
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
It would be really nice if this bot would:
Figuring out how to run make validate locally appears to be non-trivial, so that would really help. |
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
| * as long as the networking layer is configured to wait for remote clusters that are | ||
| * not responding (typically 30 seconds). | ||
| */ | ||
| timeout?: Duration // default: unset |
There was a problem hiding this comment.
The documentation doesn't reflect any comments like that, so it doesn't serve a purpose as far as I know.
For properties that have default values, @server_default xxx works for docs.
…r.json to match the new spec
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
quux00
force-pushed
the
remote-info-resolve-cluster
branch
from
58ac301 to
5012324
Compare
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-3655-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5b17efd2251c5ff382401402288b9a10694cd64f
# Push it to GitHub
git push --set-upstream origin backport-3655-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.xThen, create a pull request where the |
Relates to elastic/elasticsearch#118993 This PR updates the remote info and resolve cluster specifications to (1) copy some missing descriptions from the docs (https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html and https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html) and (2) incorporate the changes from elastic/elasticsearch#118993 Co-authored by @lcawl (cherry picked from commit 5b17efd)
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
…3667) (cherry picked from commit 5b17efd) Co-authored-by: Michael Peterson <[email protected]>
Relates to elastic/elasticsearch#118993
This PR updates the remote info and resolve cluster specifications to (1) copy some missing descriptions from the docs (https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html and https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html) and (2) incorporate the changes from elastic/elasticsearch#118993
Co-authored by @lcawl