Skip to content

[DOCS] Clarify remote/info and resolve/cluster descriptions #3654

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

Closed
wants to merge 3 commits into from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 29, 2025

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

NOTE:

  1. I noticed that the examples have been removed from the old docs, so if we need to do the same in these docs, let me know!
  2. It looks like cluster_credentials, which is mentioned in https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html, is missing from this specification.

Preview

The descriptions contain some sections, which I checked work in Bump.sh like this:

image

They also contain some > info callouts and external links, which look like this:

image

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cluster.remote_info 🟢 3/3 3/3
indices.resolve_cluster 🔴 10/12 12/12

You can validate these APIs yourself by using the make validate target.

@lcawl
Copy link
Contributor Author

lcawl commented Jan 30, 2025

Replaced by #3655

@lcawl lcawl closed this Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant