Reorganize search-speed.md by optimization type - #8276
Open
georgewallace wants to merge 10 commits into
Open
georgewallace wants to merge 10 commits into
georgewallace wants to merge 10 commits into
Conversation
…n type Resolves elastic#6943. The page was a flat list of ~20 H2 sections mixing infrastructure tuning, index design, and Query DSL-specific advice with no signal to readers using ES|QL or other query languages. Changes: - Add three H2 groups: Cluster and hardware tuning, Index design and maintenance (all query languages), and Query DSL optimizations (DSL only) - Demote existing H2s to H3; all existing anchor IDs carried over verbatim so inbound links from the elasticsearch repo are not broken - Add intro tip callout explaining which sections apply to which readers - Move index_phrases, constant_keyword, and index sorting to Index design group based on evidence from ES source that ES|QL benefits from them too - Move global ordinals to Query DSL group (ES|QL STATS BY uses its own impl) - Add cross-links to ES|QL and EQL performance guides in new Other query languages section - Add type and description frontmatter fields - Apply comprehensive style fixes: active voice, present tense, contractions, acronym expansions (JVM, LVM, SSD, ISBN, EQL), "in order to" → "to", "may" → "might" for possibility, directional "below" → "the following", "etc" → "and so on", fix broken Query DSL cross-link - Fix pre-existing "sharing strategies" typo → "sharding strategies" - Update parent optimize-performance.md annotation to reflect new structure Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ECE users configure JVM heap sizes directly (via --memory-settings and instance RAM selection), so this advice applies to ECE as well as self-managed and ECK. Verified against ece-jvm.md and resize-deployment.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Preload warning: rephrase from "too many files" to the actual condition (total preloaded data exceeds available RAM), per preloading docs - index_phrases: "2-shingles" -> "two-term word combinations (shingles)" to match ES source terminology in index-phrases.md - index_prefixes: clarify that only prefixes within the configured length range are indexed (2-5 chars by default), not all possible prefixes - Global ordinals: add diversified_sampler to the list of aggregations that use global ordinals, per eager-global-ordinals.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Rewrite the description to lead with the primary ranking queries (elasticsearch performance tuning, query optimization) and add latency/throughput signals to improve CTR from organic search. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- "in order to" → "to" (wordiness) - "what is" → "what's" (contraction) - "you'll write" → "you plan to write" (future tense → present) - "that is used" → "that's used" (contraction) - "should be mapped" → "needs to be mapped" (subjunctive) - "you could split" → "you can split" (subjunctive) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- H1: "Tune Elasticsearch for search speed" (includes product name per title guidance) - navigation_title: "Tune for search speed" (pins sidebar label, unchanged from before) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
georgewallace
force-pushed
the
gwallace/search-speed-reorg
branch
from
September 11, 2026 13:17
4b0f3d7 to
11f47e1
Compare
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
The annotation was redundant with the tip callout at the top of search-speed.md and read awkwardly as subordinate list text. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- "heavily relies" → "relies heavily" - Add missing comma after "For instance" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
🔍 Preview links for changed docs |
Contributor
Elastic Docs Style Checker (Vale)Summary: 3 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/production-guidance/optimize-performance/search-speed.md | 385 | Elastic.Spelling | 'cacheable' is a possible misspelling. |
| deploy-manage/production-guidance/optimize-performance/search-speed.md | 435 | Elastic.Spelling | 'cacheable' is a possible misspelling. |
| deploy-manage/production-guidance/optimize-performance/search-speed.md | 435 | Elastic.Spelling | 'cacheable' is a possible misspelling. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
georgewallace
marked this pull request as ready for review
September 11, 2026 15:36
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #6943
Made structural changes based on the issue suggestion. Decided to break it up into 3 sections because some of the query guidance is relevant to all query languages and some for Query DSL only. Did an SEO pass on the page and also validated the context in the doc with information from the elasticsearch repo to ensure it is correct.
What changed
search-speed.md: restructured from a flat list of ~20 H2 sections into three labeled groups:All 28 original anchors preserved verbatim (two are load-bearing cross-repo references from
elasticsearch/node-settings.mdandelasticsearch/copy-to.md).Additional fixes made while restructuring:
applies_tovalidated against theelasticsearchrepo; addedece: allto the filesystem cache sectionindex_phrasesterminology,index_prefixesscope, addeddiversified_samplerto the global ordinals aggregation listnavigation_titleadded to keep the sidebar label unchangeddescriptionfrontmatter for SEO (leads with top-ranking queries: "elasticsearch performance tuning", "query optimization")optimize-performance.md: removed the bullet and annotation for ES|QL. We already link to this topic from the search-speed page and other places, the annotation made the list render strangely. Looking at traffic data the vast majority of folks that landed on the es|ql performance page came from search-speed not from optimize performance.Notes
indexing-speed,disk-usage, etc.) still use "Tune for X" H1s without the product name, a follow-on will update those to Pattern A or Pattern B oncemeta_titleships in docs-builder.🤖 Generated with Claude Code