Backport custom_documentation #435 to 8.10.3

[gabriellandau]

Backport #435 to 8.10.3.

[elasticmachine]

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2023-10-03T18:08:51.451+0000

• Duration: 8 min 47 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

• /test : Re-trigger the build.

[pzl]

I'm not entirely sure what the.. deployment or viewing/consumption process of the custom_documentation stuff is.

@ferullo is the stuff in custom_documentation versioned at all? It just points to this repo, right? Is it branch-aware? If its not, then backport was probably unnecessary

[ferullo]

It's not branch aware itself. But the issue is automated Endpoint testing validates all Endpoint documents against custom_documentation and the package schema using a single submodule of this repo. The issue Gabe identified was that main increased the ECS version from 8.7 to 8.10.

Endpoint's 8.10 branch shouldn't be tested against that change, since that change is in endpoint-package 8.11, not endpoint-package 8.10. So, at least right now, we need a single commit hash of endpoint-package that has the 8.10 package schema in it and any custom_documentation changes that we also needed to make.

We could also just have made an 8.10-endpoint-testing branch that off 8.10 that has the custom_documentation stuff in it. But since custom_documentation doesn't really affect the package (especially in 8.11+ where it'll entirely be in the custom_documentation/ directory) that didn't feel like worth the effort. I don't mind if you think it is, we can do that in the future.

This isn't a great long term solution. IMO, conceptually custom_documentation belongs in this repo, but functionally it's not working well. I can look into moving it out, but I'm not sure we're better off doing that as a part of a larger changes to move this package into the main integration repo?