docs(table-design): make Index Overview default-first#3941
Merged
Conversation
Lead with what every table already has (an automatic prefix index on the sort key and a ZoneMap index on every column), then a decision table for when to add a manual index, with a 'when needed' frequency column. Rename the per-scenario section to 'How Each Index Works' since selection now happens up front. Applies to both current docs and version-4.x.
Mirror the English default-first restructure: lead with the automatic prefix and ZoneMap indexes plus a decision table, rename the per-scenario section. Current docs and version-4.x.
Contributor
Author
|
Update: added the 中文 counterparts, so this PR is now bilingual (EN + zh-CN), covering both |
Plainer, more active wording in the Start Here section and the design-principles pointer. Meaning unchanged.
dataroaring
added a commit
that referenced
this pull request
Jun 18, 2026
) ## What A focused readability pass on the index mechanism descriptions in **Index Overview > "How Each Index Works"** (Scenarios 1-2): the prefix / inverted / ZoneMap / BloomFilter / NGram explanations. - Split long run-on sentences into short declarative ones. - Active voice with Doris as the subject (e.g. "Doris builds an inverted table…" instead of passive constructions). - Remove the marketing word "more powerful" ("replaced by the more powerful inverted index" → "replaced by the inverted index"). No technical meaning changed. Reference tables (comparison, operators) and the capability lists in Scenarios 3-4 are left as-is, since terse reference content is appropriate there. ## Scope - Touches only the scenario prose. It does **not** change the "Start Here" section, which is in PR #3941; the two PRs edit different regions of the same file. - EN + 中文; applies to both `docs/` and `versioned_docs/version-4.x`. ## Why This content reads as dense, translated-from-source prose (60+ word single sentences, marketing adjective). The rest of the page was made task-first in #3941; this brings the explanation prose to the same clarity bar.
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.
What
Rewrite the top of Table Design > Indexes > Index Overview to be default-first:
Why
The page previously opened with a prose "Quick Selection Guide" and then four scenario explanations, without stating that two useful indexes already exist by default. A reader could not quickly tell whether they need to add anything. Leading with "you already have prefix + ZoneMap; add a manual index only when a pattern is not covered" matches how an experienced user actually decides.
Scope
docs/) andversioned_docs/version-4.x.