Skip to content

[Troubleshooting] Adds cluster allocation API examples #1698

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jun 12, 2025
Merged

[Troubleshooting] Adds cluster allocation API examples #1698

merged 10 commits into from
Jun 12, 2025

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Jun 11, 2025 •
edited
Loading

Overview

Related to https://github.com/elastic/docs-projects/issues/302

This PR adds cluster allocation API examples to the Troubleshooting guide.

PREVIEW

@szabosteve szabosteve requested a review from leemthompo June 11, 2025 10:47
@szabosteve szabosteve mentioned this pull request Jun 11, 2025
Merged
@szabosteve szabosteve added documentation Improvements or additions to documentation Team:Developer Issues owned by the Developer Docs Team API docs labels Jun 11, 2025
@szabosteve szabosteve marked this pull request as ready for review June 11, 2025 11:14
@szabosteve szabosteve requested review from a team as code owners June 11, 2025 11:14
leemthompo
leemthompo approved these changes Jun 11, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New page LGTM — didn't copyedit as we're just transferring existing content

@szabosteve szabosteve requested a review from stefnestor June 11, 2025 12:28
@eedugon
Copy link
Contributor

eedugon commented Jun 11, 2025

@szabosteve , this looks great. We shouldn't forget to add in the API docs, probably at the beginning of the content of this API call, a message to point users to this new page for examples of the allocation explain API and how to troubleshoot shard allocation issues.

The main goal of adding this page is that the current Elasticsearch code is generating logs that points users to the allocation/explain API page for troubleshooting certain allocation issues. We need to ensure those users are able to find the content (which is the content of this PR).

cc: @stefnestor

@szabosteve
Copy link
Contributor Author

szabosteve commented Jun 11, 2025 •
edited
Loading

@eedugon Thanks for the reminder, yes! I have already opened this PR to add a link that points to this page to the cluster allocation API page: elastic/elasticsearch-specification#4523

kilfoyle
kilfoyle approved these changes Jun 11, 2025
View reviewed changes
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🦖

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 11, 2025 •
edited
Loading

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

@szabosteve szabosteve merged commit dd58afa into main Jun 12, 2025
7 checks passed
@szabosteve szabosteve deleted the szabosteve/issue-302-cluster-allocation branch June 12, 2025 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leemthompo leemthompo leemthompo approved these changes

@kilfoyle kilfoyle kilfoyle approved these changes

@stefnestor stefnestor Awaiting requested review from stefnestor

Assignees
No one assigned
Labels
API docs documentation Improvements or additions to documentation Team:Developer Issues owned by the Developer Docs Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@szabosteve @eedugon @leemthompo @kilfoyle