[doc] Add Before You Start the POC guide to 3.x and 4.x#3470
Merged
dataroaring merged 3 commits intoapache:masterfrom Mar 17, 2026
Merged
[doc] Add Before You Start the POC guide to 3.x and 4.x#3470dataroaring merged 3 commits intoapache:masterfrom
dataroaring merged 3 commits intoapache:masterfrom
Conversation
Add the before-you-start-the-poc document (EN + ZH) to versioned docs for 3.x and 4.x, and register it in both versioned sidebars. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
dataroaring
had a problem deploying
to
Production
GitHub Actions
Failure
Contributor
There was a problem hiding this comment.
Pull request overview
Adds the “Before You Start the POC” guide into the versioned documentation for both 3.x and 4.x (EN + zh-CN), and exposes it via the “Getting Started” sidebar entries.
Changes:
- Added
before-you-start-the-poc.mdto versioned docs for 3.x and 4.x (English) - Added zh-CN translations for both versions under
i18n/zh-CN/... - Registered the new doc IDs in both 3.x and 4.x versioned sidebars
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_sidebars/version-4.x-sidebars.json | Adds the new “before-you-start-the-poc” doc to the 4.x Getting Started sidebar. |
| versioned_sidebars/version-3.x-sidebars.json | Adds the new “before-you-start-the-poc” doc to the 3.x Getting Started sidebar. |
| versioned_docs/version-4.x/gettingStarted/before-you-start-the-poc.md | Introduces the new 4.x English POC pre-read guide page. |
| versioned_docs/version-3.x/gettingStarted/before-you-start-the-poc.md | Introduces the new 3.x English POC pre-read guide page. |
| i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/gettingStarted/before-you-start-the-poc.md | Adds the 4.x zh-CN localized page. |
| i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/gettingStarted/before-you-start-the-poc.md | Adds the 3.x zh-CN localized page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+20
to
+24
| | If your data is... | Use | Why | | ||
| |---|---|---| | ||
| | Append-only (logs, events, facts) | **Duplicate Key** (default) | Keeps all rows. Best query performance. | | ||
| | Updated by primary key (CDC, upsert) | **Unique Key** | New rows replace old rows with the same key. | | ||
| | Pre-aggregated metrics (PV, UV, sums) | **Aggregate Key** | Rows are merged with SUM/MAX/MIN at write time. | |
Comment on lines
+20
to
+24
| | 数据特征 | 使用 | 原因 | | ||
| |---|---|---| | ||
| | 仅追加（日志、事件、事实表） | **Duplicate Key**（默认） | 保留所有行。查询性能最好。 | | ||
| | 按主键更新（CDC、Upsert） | **Unique Key** | 新行按相同 Key 替换旧行。 | | ||
| | 预聚合指标（PV、UV、汇总） | **Aggregate Key** | 写入时按 SUM/MAX/MIN 合并行。 | |
- inverted-index/overview → inverted-index (no subdirectory in 3.x) - streaming-job/streaming-job-tvf → plain text (not available in 3.x) - query-acceleration/query-profile → admin-manual/open-api/fe-http/query-profile-action Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
dataroaring
had a problem deploying
to
Production
GitHub Actions
Failure
Remove hyperlinks to inverted-index doc which doesn't exist in the ZH 3.x translation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
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.
Summary
before-you-start-the-poc.md(EN + ZH) to versioned docs for 3.x and 4.xversion-3.x-sidebars.jsonandversion-4.x-sidebars.jsoncurrentversion from thebefore_pocbranchTest plan
🤖 Generated with Claude Code