Adding support to the docs for an image carousel

[kgeller]

Summary

Adding support to the docs-builder for an image carousel.

We want to use this to display the dashboard screenshots in the docs similarly to what we do already in Kibana.

The only setting for the carousel is an optional setting for fixed-height. The options are: small, medium, auto where auto simply defaults to whatever the image size is, small is 350px and medium is 750px. These sizes are just what I thought looked ok, I can change them to whatever people prefer.

How it works

We add the following directive to the docs

::::{carousel}
:fixed-height: medium
:::{image} https://epr.elastic.co/package/abnormal_security/1.8.0/img/abnormal_security-mailbox_not_analyzed_overview.png
:alt: First image description
:title: First image title
:::
:::{image} https://epr.elastic.co/package/abnormal_security/1.8.0/img/abnormal_security-ai_security_mailbox_overview.png
:alt: Second image description
:title: Second image title
:::
:::{image} https://epr.elastic.co/package/abnormal_security/1.8.0/img/abnormal_security-audit_overview.png
:alt: Third image description
:title: Third image title
:::
::::

And this is what gets generated

Screen.Recording.2025-06-18.at.4.00.13.PM.mov

Also added to the documentation of what is supported

Notes

I wanted to build upon the existing image directive just so that I could get the existing functionality there around popping open an image in a new tab.

I added the fixed-height setting as because 1) not all of these screenshots are the same size, and I didn't want the buttons to click left / right to be jumping around the screen and 2) some of them are quite large and could be quite overbearing to the page.

Relates https://github.com/elastic/integration-experience/issues/83

[Mpdreamz]

👍 💯 Great PR! What a treat to get a new directive complete with with diagnostics and ❤️ the reuse of the image directive.

I have a few small nitpicks on the options to the carrousel directive.

[reakaleek]

@elastic/docs-engineering what's missing from our side here?

How can we get this merged?

@kgeller I see this is already hanging around for 2 weeks, Sorry! But I'll make sure that is PR is on our radar next week.

Thank you for your patience and great contribution!

[Mpdreamz]

@kgeller this LGTM!

There is one merge conflict, we moved some cheese while we left this PR open sorry!

If you tackle that we can hit merge 😸

[kgeller]

@Mpdreamz Thanks so much! I took care of the conflict and should be good to go.

The current failing check looks like a 403, so maybe I don't have the appropriate permissions?

[Mpdreamz]

@reakaleek do you have an idea why we're seeing a 403 on trying to update deployment details?

Never seen this on other PR's.