Skip to content

[Docs] Includes information about available index settings in Serverless #129704

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 11 commits into from
Jul 2, 2025

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Jun 19, 2025

This Docs PR starts addressing elastic/docs-content#79

The main change is to introduce and show the list of index-level settings available in Serverless. For this purpose:

  • A new page with the list of available index settings has been created.
  • In the index-settings landing page and all relevant child pages:
    • Banner explaining that not all settings are available in serverless.
    • Serverless badges in relevant settings, next to the name.

Some screenshots for ilustrative purposes:

image
  • The refresh_interval setting has been updated as it has a different default in serverless.
image

There are other minor changes / refinement done while reviewing all the content, such as:

  • Some links to dynamic index settings were pointing to the cluster settings API doc. Fixed.
  • Some items of the index settings hierarchy were not correctly placed under shard allocation section.
  • The landing page and the general index settings had some inconsistencies with the concept index modules.
  • The TOC order of the index settings section has been updated to look a bit closer to the previous docs.

Copy link
Contributor

github-actions bot commented Jun 19, 2025

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

@shainaraskas shainaraskas self-requested a review June 19, 2025 20:14
@shainaraskas
Copy link
Contributor

@shainaraskas
Copy link
Contributor

is path in totally the wrong place??? also maybe indexing pressure I guess

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

overall, looks really good.

when i saw the mapping/metadata fields were impacted I got a little nervous - do those references need an overall note on them? wondering how much of the content is deployment-agnostic and how much of it follows this restriction pattern.

approving to unblock

@eedugon eedugon marked this pull request as ready for review June 25, 2025 11:25
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Jun 25, 2025
@eedugon eedugon added the Team:Docs Meta label for docs team label Jun 25, 2025
@eedugon eedugon requested a review from john-wagster June 25, 2025 11:30
@elasticsearchmachine elasticsearchmachine removed the Team:Docs Meta label for docs team label Jun 25, 2025
@eedugon eedugon added Team:Docs Meta label for docs team Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. labels Jun 25, 2025
@elasticsearchmachine elasticsearchmachine removed the Team:Docs Meta label for docs team label Jun 25, 2025
@eedugon eedugon added >docs General docs changes Team:Docs Meta label for docs team labels Jun 25, 2025
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jun 25, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@eedugon eedugon requested a review from dbrimley June 25, 2025 15:30
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

I typed these comments days ago and forgot to submit

Copy link
Contributor

@john-wagster john-wagster left a comment

Choose a reason for hiding this comment

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

lgtm

@eedugon
Copy link
Contributor Author

eedugon commented Jun 26, 2025

I typed these comments days ago and forgot to submit

I've updated the serverless introductory paragraph due to that. Very good point, now it's aligned with the upcoming change in elastic/docs-content#1728

@kunisen
Copy link
Contributor

kunisen commented Jun 30, 2025

@eedugon thanks for your great work! this is awesome and I love it!
I read thru the PR in a high level and it looks great!

Only one small thing, personal feeling, I found the badge serverless is a bit hard to find, given it's the same "text" but not really like a badge... 😅
Maybe not in this PR, but in the long run, could we improve the badge to make it move visible? e.g. make it an icon or make the badge a different color?

@shainaraskas
Copy link
Contributor

@kunisen we are working on the badge designs with UX now. We need to balance badge visibility with making the page too noisy (because we use these same badges everywhere), but you'll see changes to that experience in the coming months as our eng team finds time to address :)

@eedugon eedugon merged commit 3b8f5d3 into main Jul 2, 2025
10 checks passed
@eedugon eedugon deleted the index_settings_serverless branch July 2, 2025 12:40
mridula-s109 pushed a commit to mridula-s109/elasticsearch that referenced this pull request Jul 2, 2025
…ess (elastic#129704)

* index settings for serverless information added

* comment removed

* Apply suggestions from code review

Co-authored-by: shainaraskas <[email protected]>

* serverless applies removed from coerce doc

* eck applies addded to config reference landing

* toc updated

* index settings landing page aligned with toc

* serverless doc intro updated

---------

Co-authored-by: shainaraskas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. Team:Docs Meta label for docs team v9.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Serverless]: Details on what settings and system indices (if any) are available on Serverless
5 participants