Skip to content

docs(table-design): clarity pass on partitioning concepts prose (Overview & Core Concepts)#3943

Open
dataroaring wants to merge 3 commits into
apache:masterfrom
dataroaring:docs-partitioning-prose-clarity
Open

docs(table-design): clarity pass on partitioning concepts prose (Overview & Core Concepts)#3943
dataroaring wants to merge 3 commits into
apache:masterfrom
dataroaring:docs-partitioning-prose-clarity

Conversation

@dataroaring

Copy link
Copy Markdown
Contributor

What

A readability pass on the Overview (§1) and Core Concepts (§2) prose in the partitioning & bucketing concepts page (basic-concepts):

  • Shorter, declarative sentences (split 40+ word run-ons).
  • Active voice with Doris as the subject ("Doris distributes…", "Doris reads different buckets in parallel" instead of "the system…").
  • Drop translated-source patterns: "organize the data … in an orderly manner", "a reasonable X design brings the following benefits".

No technical meaning changed.

Scope

  • Touches only §1–§2 prose. Sections 3–7 (the CREATE TABLE walkthrough, design recommendations, and operational SHOW commands) are left as-is for now.
  • Does not change the page title, intro, or example trim in PR docs(table-design): add default-first Partitioning & Bucketing landing #3940; the two PRs edit different regions of the same file.
  • EN + 中文; applies to both docs/ and versioned_docs/version-4.x. (The 中文 was already close to natural; only the few verbose sentences were tightened for parity.)

Why

This is dense, translated-from-source concept prose. The page's landing/structure was made default-first in #3940; this brings its core concept prose to the same clarity bar.

…ions 1-2)

Databricks-style rewrite of the Overview and Core Concepts prose in
basic-concepts: shorter sentences, active voice with Doris as subject, drop the
translated 'a reasonable X design brings the following benefits' / 'in an
orderly manner' patterns. Sections 3-7 (CREATE TABLE walkthrough, design
recommendations, operations) left as-is. EN + zh-CN. Does not touch the title,
intro, or example trim from PR apache#3940 (different regions of the same file).
The previous wording ('Unlike partitions, which split by column value, bucketing
spreads data evenly') implied bucketing does not use column values, but Hash
bucketing does. Restore the real distinction: partitions divide by ranges or
lists of column values; bucketing spreads data evenly across buckets. EN + zh-CN.
…-ins

More neutral reference-doc register for the partition/bucket benefit lists.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant