Skip to content

Improve listing of index mode options in docs #127155

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 3 commits into from
Apr 24, 2025

Conversation

ioanatia
Copy link
Contributor

@ioanatia ioanatia commented Apr 22, 2025

currently there is no visual break between the options for index.mode and index.routing_partition_size which is an index setting:

Screenshot 2025-04-22 at 16 31 39

checking to see if this change makes it better (looks good in my editor), but in the end it depends on how the docs are actually rendered.

EDIT: this is how it looks in the preview

Screenshot 2025-04-22 at 17 35 34

@ioanatia ioanatia added >docs General docs changes >non-issue Team:Docs Meta label for docs team labels Apr 22, 2025
@ioanatia ioanatia marked this pull request as ready for review April 22, 2025 15:36
@ioanatia ioanatia requested a review from leemthompo April 22, 2025 15:36
@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo
Copy link
Contributor

leemthompo commented Apr 22, 2025

Thanks for catching this @ioanatia. I think there is also an indentation issue with nested definition lists here. It's a little finicky.

I noodled on this locally, if you're happy with this output I can push a commit :)
Screenshot 2025-04-22 at 18 24 49

Note the example block and subsequent text are indented.

I also added subheadings to clarify sub-sections and link to lookup join.

@ioanatia
Copy link
Contributor Author

@leemthompo feel free to push a commit

@leemthompo
Copy link
Contributor

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Thanks for opening the PR @ioanatia 🥇

@leemthompo leemthompo added auto-backport Automatically create backport pull requests when merged v9.0.0 labels Apr 23, 2025
@ioanatia ioanatia merged commit a684e10 into elastic:main Apr 24, 2025
6 checks passed
@ioanatia ioanatia deleted the index-mode-docs branch April 24, 2025 07:58
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
9.0 Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 127155

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 backport pending >docs General docs changes >non-issue Team:Docs Meta label for docs team v9.0.0 v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants