[docs] Simplify and retitle the POC getting started guide#3455
Closed
dataroaring wants to merge 23 commits intoapache:masterfrom
Closed
[docs] Simplify and retitle the POC getting started guide#3455dataroaring wants to merge 23 commits intoapache:masterfrom
dataroaring wants to merge 23 commits intoapache:masterfrom
Conversation
- Replace bucket guidance with clear four-rule approach - Rename section headings (Sort Key, Example Templates, Performance Pitfalls) - Merge sparse partition section into single paragraph - Remove unnecessary Fixing Mistakes section - Fix broken link and rule count reference Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Demote sections 1-4 and Important Notes from h2 to h3, nested under a new 'Table Design' (建表设计) h2 parent heading. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Significantly shorten Table Design section — remove verbose explanations, keep only actionable guidance, and link to existing docs for details. Also trim Example Templates descriptions and Performance Pitfalls to one-liners with references. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix "performance can sustain" → "performance holds up" - Merge competing intros under Table Design - Replace em dashes with periods/commas throughout - Remove "small tablets" bullet (overlaps with bucket rule 2) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove repeated "data model cannot be changed" (already in intro) - Replace repeated sort key advice with anchor link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ify load_to_single_tablet Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Renames and rewrites the “Must Read Before the POC” Getting Started documentation page into a new “Before You Start the POC” page (EN + zh-CN) and updates the sidebar entry accordingly.
Changes:
- Update Getting Started sidebar to point to the new doc ID
gettingStarted/before-you-start-the-poc. - Replace the old EN page (
must-read-before-poc.md) with a new, shorter EN page (before-you-start-the-poc.md). - Replace the old zh-CN translation with a new zh-CN page matching the new filename/structure.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Updates the sidebar to reference the renamed Getting Started doc. |
| docs/gettingStarted/must-read-before-poc.md | Removes the old EN page. |
| docs/gettingStarted/before-you-start-the-poc.md | Adds the new EN page content under the new filename. |
| i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/must-read-before-poc.md | Removes the old zh-CN page. |
| i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/before-you-start-the-poc.md | Adds the new zh-CN page content under the new filename. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 'gettingStarted/what-is-apache-doris', | ||
| 'gettingStarted/quick-start', | ||
| 'gettingStarted/must-read-before-poc', | ||
| 'gettingStarted/before-you-start-the-poc', |
There was a problem hiding this comment.
This sidebar entry switches the doc ID from gettingStarted/must-read-before-poc to gettingStarted/before-you-start-the-poc, which changes the published URL and will 404 any existing inbound links/bookmarks to the old page. Since the repo already uses @docusaurus/plugin-client-redirects, please add a redirect (and ideally the zh-CN equivalent) from the old path to the new one, or keep the old slug/doc ID and only update the title/content to preserve the URL.
Suggested change
| 'gettingStarted/before-you-start-the-poc', | |
| 'gettingStarted/must-read-before-poc', |
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 POCand update the sidebar path accordingly