Skip to content

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Aug 13, 2025

As discussed as part of Edu's ILM docs review, this PR:

Please see the updated version: Troubleshoot index and snapshot lifecycle management

Rel: #190

Copy link

github-actions bot commented Aug 13, 2025

@kilfoyle kilfoyle requested a review from yetanothertw August 22, 2025 19:20
@kilfoyle kilfoyle marked this pull request as ready for review August 22, 2025 19:20
@kilfoyle kilfoyle requested review from a team as code owners August 22, 2025 19:20
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.

I've left a few comments for your consideration. Let me know what you think.

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.

I've left some minor formatting comments and something odd is going on with the mini TOC here

## Check status, stop, and restart {{ilm-init}} [check-stop-start-ilm]

5. Verify {{ilm}} is now running:
:::{include} ../../manage-data/_snippets/start-stop-ilm.md
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure what is causing this (maybe it's the snippet?), but there's some funkiness going on with the mini-toc on the right (the order of the headings does not reflect the actual page):
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching that @yetanothertw ! I can't figure out why it's not working, but reversing the order with the SLM section first allows the right-side nav to display properly. So now it looks like this:

nav

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm. The preview version doesn't seem to show the above yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In my local preview build the right-side navigation displays nicely, but in the PR preview build the navigation seems to be in the wrong order. I've opened an issue for this: elastic/docs-builder#1880

Copy link
Contributor

Choose a reason for hiding this comment

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

Still looks off, even with the inverted order:
image

I think you might have to try the workaround that Shaina suggested, hopefully that'll do it. 🤞

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

approved in theory. will say that the only workaround I know of for this annoying heading issue is to break the snippet up and add the headings to the targets.

@kilfoyle
Copy link
Contributor Author

Thanks. I split up the snippets file as suggested. Not ideal but at least our nav looks less wonky. :-)

screen

@kilfoyle kilfoyle merged commit e2a7328 into elastic:main Sep 17, 2025
6 of 7 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.

3 participants