Skip to content

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Aug 12, 2025

Added missing docs for the following features or settings:

verified to be present in 8.19 code

docs were backported as is with only edits to make them compatible with asciidoc syntax.

this is currently not passing rest tests due to cleanup/teardown requirements and the pickiness of tests.

@jbaiera hoping I can get your help with cleaning these tests up - it's unclear to me how many of the snippets SHOULD be failing due to this being a failure resolution tool. I spent a couple of hours on it but was worried I was changing things that altered the meaning of the snippets.

@shainaraskas shainaraskas added >docs General docs changes Team:Docs Meta label for docs team v8.19.3 labels Aug 12, 2025
Copy link
Contributor

Documentation preview:

@shainaraskas shainaraskas marked this pull request as ready for review August 13, 2025 13:07
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jbaiera
Copy link
Member

jbaiera commented Aug 21, 2025

@shainaraskas thanks so much for putting in the leg work to get this backported. I'll take a look at the tests and see if I can get them to green.

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/core-docs (Team:Docs)

@jbaiera
Copy link
Member

jbaiera commented Sep 18, 2025

I wanted to circle back to this. These docs really weren't written with docs testing in mind. Each case requires extensive setup and teardown, and they're all quite different from each other such that it can't be the same setup/teardown logic for each test.

I have some tests running after quite a bit of effort, but there's still so much to fix up here before it can execute correctly. Would it be reasonable to mute the remaining failure store tests in the 8.19 branch? We would need to revisit them when testing is reintroduced in the new docs system, but I imagine that there will be plenty of other things that will also need fixing by then.

@shainaraskas
Copy link
Contributor Author

@jbaiera that would be ok with me if it's ok with you and your team.

@jbaiera
Copy link
Member

jbaiera commented Sep 18, 2025

I've fixed a few tests and muted the rest of them with 4587b74

@shainaraskas shainaraskas requested a review from a team September 18, 2025 20:40
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! 🦘

They build nicely and from spot-checking the output all looks good.

@shainaraskas shainaraskas merged commit 2da39f9 into 8.19 Sep 19, 2025
7 checks passed
@shainaraskas shainaraskas deleted the just-failure-store branch September 19, 2025 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v8.19.5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants