Skip to content

Fix up 'phase actions' section #2076

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

Merged
merged 11 commits into from
Jul 15, 2025
Merged

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jul 8, 2025

Based on feedback from Support, this PR:

  • Clarifies the definitions of the hot and warm ILM phases, since users do indeed update indices during those phases.
  • Adds a description for each phase action so people don't have to jump back and forth to the reference docs. I put this in tables for easier reading.
  • Adds a table summarizing which actions are available in which phases.

Note: I wanted to have one large table showing all actions, their descriptions, and the phases in which they're available, but there are two problems:

  • Markdown doesn't support column spanning, which makes the table unwieldly.
  • The order the actions is important and it's not the same for each phase, so we need a separate table for each phase.

Closes: #1559

Copy link

github-actions bot commented Jul 8, 2025

🔍 Preview links for changed docs

@kilfoyle kilfoyle marked this pull request as ready for review July 9, 2025 18:41
@kilfoyle kilfoyle requested a review from a team as a code owner July 9, 2025 18:41
@kilfoyle kilfoyle marked this pull request as draft July 9, 2025 18:42
@kilfoyle kilfoyle marked this pull request as ready for review July 9, 2025 18:42
@yetanothertw yetanothertw self-assigned this Jul 15, 2025
Copy link
Contributor

@yetanothertw yetanothertw left a comment

Choose a reason for hiding this comment

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

The section looks so much better and easier to read with the added tables and extra context. Thank you for fixing it up! :)

I can see what you mean about it being tricky to combine
all the tables into one. But I think the last table that reflects availability for each action and phase combo is very useful and complements the standalone phase-focused tables.


| Action | Description |
| --- | --- |
| [Set Priority](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-set-priority.md) | Sets the priority level of the index, which determines the order in which indices are recovered following a node restart. |
Copy link
Contributor

Choose a reason for hiding this comment

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

A more general comment about action capitalization. The linked references all use sentence case, like Set priority instead of Set Priority. Should we be using the same in the tables here?

There's another discrepancy with hyphenation in Read-Only and [Read only](https://www.elastic.co/docs/reference/elasticsearch/index-lifecycle-actions/ilm-readonly) -- the latter should probably be Read-only.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For sure! Thanks a lot for catching that.

kilfoyle and others added 8 commits July 15, 2025 09:36
…le.md

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…le.md

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…le.md

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…le.md

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…le.md

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…le.md

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
@kilfoyle kilfoyle merged commit a29b3ae into elastic:main Jul 15, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Data lifecycle docs: Index lifecycle and phase actions
2 participants