Skip to content

[DOCS] Fix broken images #126648

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 5 commits into from
Apr 12, 2025
Merged

[DOCS] Fix broken images #126648

merged 5 commits into from
Apr 12, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 11, 2025

Relates to elastic/docs-content#1079

Fixes broken images in the following pages:

In the case of the images that are used in snippets...since the snippets are being used in pages that belong to two different toc.yml files in two different paths, it seems like the solution is to not re-use the snippet. Thus I've put the image in both of the appropriate folders and copied the re-used text into one of the files directly. Since the second usage of the snippet involves generated files, I've left it as-is for now.

Preview

@lcawl lcawl added >docs General docs changes Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v9.0.1 v9.1.0 labels Apr 11, 2025
@lcawl lcawl requested a review from a team April 11, 2025 02:59
@lcawl lcawl mentioned this pull request Apr 10, 2025
58 tasks
@lcawl lcawl marked this pull request as ready for review April 11, 2025 03:11
@elasticsearchmachine
Copy link
Collaborator

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

@theletterf
Copy link
Contributor

theletterf commented Apr 11, 2025

Perhaps we could dispense from the picture and just explain what to expect in the chart? Or leave the chart out of the snippet.

I lack context though, so I might as well have suggested something impractical. Ignore my comment if you think that's the case. 🙇🏻‍♂️

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! 🥝
(approving just in case you don't find another approach for this one).

@lcawl lcawl marked this pull request as draft April 12, 2025 00:26
@lcawl lcawl changed the title [DOCS] Fix use of cardinality_error.png [DOCS] Fix broken images Apr 12, 2025
@lcawl lcawl marked this pull request as ready for review April 12, 2025 01:37
@lcawl
Copy link
Contributor Author

lcawl commented Apr 12, 2025

Perhaps we could dispense from the picture and just explain what to expect in the chart? Or leave the chart out of the snippet.

Yes, I think there's definitely a better solution but since it's a small bit of content that's being re-used (and we're trying to avoid the complexity of re-use in general), I'll go ahead with the current solution of putting the same info in two places.

@lcawl lcawl merged commit ae33eaa into elastic:main Apr 12, 2025
6 checks passed
@lcawl lcawl deleted the image-paths branch April 12, 2025 02:04
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
9.0

lcawl added a commit to lcawl/elasticsearch that referenced this pull request Apr 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v9.0.1 v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants