This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 4f583ff1e67 [fix](i18n) Correct stale sources and repair Korean T09
pages (#4406)
4f583ff1e67 is described below
commit 4f583ff1e671e5ec31a0bdbaa4ab882fbea3a6fc
Author: Mingyu Chen (Rayner) <[email protected]>
AuthorDate: Mon Oct 19 21:14:55 2026 +0100
[fix](i18n) Correct stale sources and repair Korean T09 pages (#4406)
## Summary
Follow-ups from reviewing the Korean T09 batches (#4366–#4404, all
merged).
1. **Corrupted Korean page.** In the Dev Korean
`admin-manual/maint-monitor/automatic-service-start.md`, the systemd
example had `--daemon` followed by U+0002 and `0` instead of the
source's trailing space. Restored.
2. **Stale contribution guide.**
`community/how-to-contribute/contribute-doc.md` (English and Chinese)
still said the Dev sidebar is `sidebars.json` and listed versions
1.2/2.0/2.1. It now points at `sidebars.ts` and the released versions in
`versions.json` (4.x, 3.x, 2.1), says that the
`version-1.2`/`version-2.0` directories are not built, refreshes the
directory trees, uses existing label keys in the `current.json`
examples, and fixes the key format (`[type]` + `.` + `[label]`). The
Korean page follows the corrected source.
3. **Unclosed code block.** The English 4.x, 3.x and 2.1 `ANALYZE.md`
ended inside an unclosed `sql` block. Dev English and every Chinese
version already close it, so only these three change. The Korean 4.x
page follows.
4. **Retained third-attempt warnings.** Each of the 29 Korean pages that
T09 accepted with warnings was compared with its source: 3 are fixed
here and 26 are accepted. Besides the two pages above, the 4.x Korean
`lance-catalog.mdx` had dropped the code formatting of one `NULL`. Once
edited, a page no longer uses the third-attempt exception, so it now
passes the full protected-content check: 15 sentences were reordered to
the English inline-code order and "three-dimensional" is written as 삼차원.
Per-page conclusions are below.
## Translation state
- The four Korean page states record the new target hashes; their
`generation` records are kept as history. Because an edited target no
longer matches its generation record, the PR gate applies the strict
protected-content comparison to it.
- `contribute-doc` and 4.x `ANALYZE` changed source, so their
`sourceCommit` is d45c715, the source commit in this PR. After a squash
merge that commit is reachable only through this PR. The gate passes;
the next English change to these two pages will get a full instead of an
incremental retranslation.
- The Japanese `contribute-doc` and 4.x `ANALYZE` become stale with the
source change and show English until the scheduled Japanese translation
refreshes them, as with #4290.
## Validation
- `check-translations.cjs --base 26972a5`: ko checked 4 pages, 0 errors,
0 warnings, 3336 current; ja 0 errors.
- Each edited Korean page passes the strict and normalized
protected-content signatures, front matter, syntax, internal link,
glossary and Korean script checks.
- `check_md_links_single.py --no-external` on the 9 changed Markdown
files, `check_move.js` and `check-configuration --all` pass.
`build-scope`: en, zh-CN, ko; current, 4.x, 3.x, 2.1; partial build.
- The docs governance and changed-link reports contain only existing
report-only findings (SEO titles shared across versions, description
length, external links, contribute-doc missing from the community
sidebar).
- No local site build; CI builds the affected locales and versions.
<details>
<summary>Warning dispositions (29 pages)</summary>
| Version | Source | Category | Conclusion |
| --- | --- | --- | --- |
| Dev | `docs/admin-manual/maint-monitor/automatic-service-start.md` |
fixed | Fixed: restored the space after `--daemon` (the model emitted
U+0002 and 0 in the systemd example). |
| 4.x |
`versioned_docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx` |
fixed | Fixed: restored the `NULL` inline code; reordered 15 sentences
to the English inline-code order and wrote "three-dimensional" as 삼차원. |
| 4.x |
`versioned_docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md`
| fixed | Fixed with the source: the English page ended inside an
unclosed sql block; both pages now close it. |
| Dev | `docs/admin-manual/config/fe-config.md` | numbers | Accepted: "2
log files" written as 두 (two); meaning unchanged. |
| Dev |
`docs/connection-integration/data-integration/flink-doris-connector/faq.md`
| numbers | Accepted: "two-phase commit" written as 2단계 커밋; meaning
unchanged. |
| Dev | `docs/key-features/reciprocal-rank-fusion.mdx` | glossary |
Accepted: "catalog/document search" is the general word, not the Doris
Catalog term; 카탈로그 is correct. |
| community | `community/developer-guide/regression-testing.md` | order
| Accepted: inline code or links reordered within the same sentence or
table row by Korean word order; values identical, no cross-line moves. |
| Dev | `docs/admin-manual/auth/authentication-and-authorization.md` |
order | Accepted: inline code or links reordered within the same
sentence or table row by Korean word order; values identical, no
cross-line moves. |
| Dev | `docs/admin-manual/auth/authorization/ranger-hive.md` | order |
Accepted: inline code or links reordered within the same sentence or
table row by Korean word order; values identical, no cross-line moves. |
| Dev | `docs/admin-manual/config/be-config.md` | order | Accepted:
inline code or links reordered within the same sentence or table row by
Korean word order; values identical, no cross-line moves. |
| Dev | `docs/key-features/embedding.mdx` | order | Accepted: inline
code or links reordered within the same sentence or table row by Korean
word order; values identical, no cross-line moves. |
| Dev | `docs/lakehouse/catalogs/fluss-catalog.md` | order | Accepted:
inline code or links reordered within the same sentence or table row by
Korean word order; values identical, no cross-line moves. |
| Dev | `docs/observability/dogstack/kubernetes.md` | order | Accepted:
inline code or links reordered within the same sentence or table row by
Korean word order; values identical, no cross-line moves. |
| Dev |
`docs/sql-manual/basic-element/sql-data-types/semi-structured/VARIANT.md`
| order | Accepted: inline code or links reordered within the same
sentence or table row by Korean word order; values identical, no
cross-line moves. |
| 4.x |
`versioned_docs/version-4.x/admin-manual/auth/authorization/ranger-hive.md`
| order | Accepted: inline code or links reordered within the same
sentence or table row by Korean word order; values identical, no
cross-line moves. |
| 4.x |
`versioned_docs/version-4.x/lakehouse/best-practices/doris-lance.mdx` |
order | Accepted: inline code or links reordered within the same
sentence or table row by Korean word order; values identical, no
cross-line moves. |
| Dev | `docs/admin-manual/auth/authentication/ldap.md` |
code-whitespace+order | Accepted: code blocks differ only in trailing
whitespace, and inline code is reordered within single lines by Korean
word order; rendered commands and values unchanged. |
| Dev |
`docs/admin-manual/auth/integrations/aws-authentication-and-authorization.md`
| code-whitespace+order | Accepted: code blocks differ only in trailing
whitespace, and inline code is reordered within single lines by Korean
word order; rendered commands and values unchanged. |
| Dev | `docs/admin-manual/log-management/fe-log.md` |
code-whitespace+order | Accepted: code blocks differ only in trailing
whitespace, and inline code is reordered within single lines by Korean
word order; rendered commands and values unchanged. |
| Dev | `docs/admin-manual/auth/authorization/data.md` | code-whitespace
| Accepted: code blocks differ only in trailing whitespace from the
English source; rendered output and commands unchanged. |
| Dev | `docs/admin-manual/open-api/be-http/compaction-status.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/debug-point-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/log-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/meta-info-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/node-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/query-profile-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/query-stats-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/set-config-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
| Dev | `docs/admin-manual/open-api/fe-http/show-data-action.md` |
code-whitespace | Accepted: code blocks differ only in trailing
whitespace from the English source; rendered output and commands
unchanged. |
</details>
## Versions
- [x] dev
- [x] 4.x
- [x] 3.x
- [x] 2.1 or older (not covered by version/language sync gate)
## Languages
- [x] Chinese
- [x] English
Korean pages and their translation state also change.
## Docs Checklist
- [x] Checked by AI
- [ ] Test Cases Built (not applicable: documentation and translation
state only)
- [x] Updated required version and language counterparts, or explained
why not
- [x] If only one language changed, confirmed whether source/translation
counterparts need sync
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: morningman <[email protected]>
Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
---
community/how-to-contribute/contribute-doc.md | 201 ++++++++++-----------
.../current/how-to-contribute/contribute-doc.md | 201 ++++++++++-----------
.../maint-monitor/automatic-service-start.md | 2 +-
.../lakehouse/catalogs/lance-catalog.mdx | 36 ++--
.../sql-statements/statistics/ANALYZE.md | 1 +
.../current/how-to-contribute/contribute-doc.md | 201 ++++++++++-----------
.../current/how-to-contribute/contribute-doc.json | 10 +-
.../4.x/lakehouse/catalogs/lance-catalog.json | 4 +-
.../sql-statements/statistics/ANALYZE.json | 10 +-
.../maint-monitor/automatic-service-start.json | 4 +-
.../sql-statements/statistics/ANALYZE.md | 2 +-
.../sql-statements/statistics/ANALYZE.md | 2 +-
.../sql-statements/statistics/ANALYZE.md | 2 +-
13 files changed, 331 insertions(+), 345 deletions(-)
diff --git a/community/how-to-contribute/contribute-doc.md
b/community/how-to-contribute/contribute-doc.md
index 4d843240353..a7cb768b4fe 100644
--- a/community/how-to-contribute/contribute-doc.md
+++ b/community/how-to-contribute/contribute-doc.md
@@ -52,7 +52,6 @@ The following is the main directory tree of the
[apache/doris-website](https://g
```plain
.
├── blog
-│ ├── 1.1 Release.md
│ ├── Annoucing.md
│ ├── jd.md
│ ├── meituan.md
@@ -66,37 +65,36 @@ The following is the main directory tree of the
[apache/doris-website](https://g
│ ├── ......
├── docs
│ ├── admin-manual
+│ │ ├── auth
│ │ ├── cluster-management
│ │ ├── config
│ │ ├── data-admin
-│ │ ├── http-actions
+│ │ ├── log-management
│ │ ├── maint-monitor
-│ │ ├── privilege-ldap
-│ │ ├── multi-tenant.md
-│ │ ├── optimization.md
-│ │ ├── query-profile.md
-│ │ └── sql-interception.md
-│ │ └── workload-group.md
+│ │ ├── open-api
+│ │ ├── system-tables
+│ │ ├── trouble-shooting
+│ │ ├── workload-management
+│ │ └── audit-plugin.md
│ ├── ......
├── i18n
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
│ │ ├── current
-│ │ ├── version-1.2
-│ │ ├── version-2.0
│ │ ├── version-2.1
+│ │ ├── version-3.x
+│ │ ├── version-4.x
│ │ ├── current.json
-│ │ ├── version-1.2.json
-│ │ ├── version-2.0.json
│ │ ├── version-2.1.json
-│ ├── docusaurus-plugin-content-docs-community
-│ └── local_build_docs.sh
+│ │ ├── version-3.x.json
+│ │ └── version-4.x.json
+│ └── docusaurus-plugin-content-docs-community
├── src
│ ├── components
│ │ ├── Icons
│ │ ├── More
-│ │ ├── PageBanner
-│ │ └── PageColumn
+│ │ ├── PageColumn
+│ │ └── PageHeader
│ ├── ......
├── static
│ ├── images
@@ -105,20 +103,19 @@ The following is the main directory tree of the
[apache/doris-website](https://g
│ └── js
│ └── redirect.js
├── versioned_docs
-│ ├── version-1.2
-│ ├── version-2.0
-│ └── version-2.1
+│ ├── version-2.1
+│ ├── version-3.x
+│ └── version-4.x
├── versioned_sidebars
-│ ├── version-1.2-sidebars.json
-│ ├── version-2.0-sidebars.json
-│ └── version-2.1-sidebars.json
-├── babel.config.js
+│ ├── version-2.1-sidebars.json
+│ ├── version-3.x-sidebars.json
+│ └── version-4.x-sidebars.json
├── build.sh
-├── buildVersions.sh
├── docusaurus.config.js
+├── local_build_docs.sh
├── package.json
├── README.md
-├── sidebars.json
+├── sidebars.ts
├── sidebarsCommunity.json
├── tsconfig.json
└── versions.json
@@ -131,13 +128,14 @@ The following table summarizes the purpose of each
directory to help you quickly
| `blog/` | Blog article Markdown files | Shared across all versions |
| `community/` | English community documentation | Shared across all versions |
| `docs/` | English latest version (Dev / Master) documentation | Current main
branch |
-| `versioned_docs/version-X.X/` | English historical version documentation |
1.2 / 2.0 / 2.1, etc. |
+| `versioned_docs/version-X.X/` | English documentation for released versions
| 4.x / 3.x / 2.1 (listed in `versions.json`) |
| `i18n/zh-CN/docusaurus-plugin-content-docs/current/` | Chinese latest
version documentation | Current main branch |
-| `i18n/zh-CN/docusaurus-plugin-content-docs/version-X.X/` | Chinese
historical version documentation | 1.2 / 2.0 / 2.1, etc. |
+| `i18n/zh-CN/docusaurus-plugin-content-docs/version-X.X/` | Chinese
documentation for released versions | 4.x / 3.x / 2.1 (listed in
`versions.json`) |
| `i18n/zh-CN/docusaurus-plugin-content-docs-community/` | Chinese community
documentation | Shared across all versions |
-| `sidebars.json` | Sidebar for the latest version of the documentation |
Shared between Chinese and English |
-| `versioned_sidebars/version-X.X-sidebars.json` | Sidebar for historical
version documentation | Shared between Chinese and English |
+| `sidebars.ts` | Sidebar for the latest version of the documentation | Shared
between Chinese and English |
+| `versioned_sidebars/version-X.X-sidebars.json` | Sidebar for released
version documentation | Shared between Chinese and English |
| `sidebarsCommunity.json` | Sidebar for community documentation | Shared
across all versions |
+| `versions.json` | Released versions published on the website | All released
versions |
| `static/images/` | Documentation image resources | Shared across all
versions |
## Blog Directory
@@ -152,7 +150,7 @@ If you want to contribute to the blog or share your
technical insights, you are
When modifying documentation, depending on the type of change, you need to
modify different files at the same time:
-1. **Modifying existing documentation content**: You need to update both the
latest documentation version on the Master branch and the corresponding version
branches (such as 2.1, 2.0, 1.2, or multiple versions).
+1. **Modifying existing documentation content**: You need to update both the
latest documentation version on the Master branch and the corresponding
released versions (such as 4.x, 3.x, 2.1, or several of them).
2. **Adding new documentation**: In addition to uploading the new Markdown
file, you also need to add the new documentation link path in the sidebar file.
3. **Adding a new documentation category**: In addition to adjusting the
directory structure, you also need to add the Chinese translation for the new
category.
@@ -161,8 +159,8 @@ The file types that need to be modified are as follows:
| File type | Purpose | Example |
| --- | --- | --- |
| Markdown file | Documentation body content | `docs/admin-manual/xxx.md` |
-| Sidebar file | Controls the directory structure | `sidebars.json` /
`version-2.1-sidebars.json` |
-| Translation file | Controls how categories are displayed in the Chinese
documentation | `current.json` / `version-2.1.json` |
+| Sidebar file | Controls the directory structure | `sidebars.ts` /
`version-4.x-sidebars.json` |
+| Translation file | Controls how categories are displayed in the Chinese
documentation | `current.json` / `version-4.x.json` |
:::caution Note
@@ -192,38 +190,36 @@ All documentation must include both Chinese and English
versions. Otherwise, the
**2. Documentation directory structure**
-For the Dev version, both Chinese and English documentation are controlled by
`sidebars.json` in the root directory.
-
-Example of `sidebars.json`:
-
-```json
-{
- "docs": [
- {
- "type": "category",
- "label": "Getting Started",
- "items": [
- "get-starting/quick-start",
- "get-starting/what-is-apache-doris"
- ]
- },
- {
- "type": "category",
- "label": "Install and Deploy",
- "items": [
- "install/standard-deployment",
- {
- "type": "category",
- "label": "Docker Deployment",
- "items": [
- "install/construct-docker/build-docker-image",
- "install/construct-docker/run-docker-cluster"
- ]
- }
- ......
- }
- ]
- }
+For the Dev version, both Chinese and English documentation are controlled by
`sidebars.ts` in the root directory.
+
+Example of `sidebars.ts`:
+
+```ts
+const sidebars: SidebarsConfig = {
+ docs: [
+ {
+ type: 'category',
+ label: 'Get Started',
+ collapsible: false,
+ collapsed: false,
+ items: [
+ {
+ type: 'category',
+ label: 'Getting Started',
+ link: {type: 'doc', id: 'getting-started/intro'},
+ collapsed: true,
+ items: [
+ 'getting-started/what-is-apache-doris',
+ 'getting-started/quick-start',
+ 'getting-started/before-you-start-the-poc',
+ ],
+ },
+ ......
+ ],
+ },
+ ......
+ ],
+};
```
**3. Chinese translation for categories**
@@ -232,8 +228,8 @@ The Chinese translation file for Dev version categories is
located at `i18n/zh-C
Taking the category "Getting Started" as an example:
-- `sidebar.docs.category.Getting Started` corresponds to the `label` hierarchy
in `sidebars.json`.
-- The format is: `sidebar` + `.` + `docs` + `.` + `[type]` + `[label]`.
+- `sidebar.docs.category.Getting Started` corresponds to the `label` hierarchy
in `sidebars.ts`.
+- The format is: `sidebar` + `.` + `docs` + `.` + `[type]` + `.` + `[label]`.
```json
{
@@ -249,34 +245,33 @@ Taking the category "Getting Started" as an example:
}
```
-The corresponding `sidebars.json` snippet:
+The corresponding `sidebars.ts` snippet:
-```json
+```ts
{
- "docs": [
- {
- "type": "category",
- "label": "Getting Started",
- "items": [
- "get-starting/quick-start",
- "get-starting/what-is-apache-doris"
- ]
- },
- ......
- }
- ]
- }
+ type: 'category',
+ label: 'Getting Started',
+ link: {type: 'doc', id: 'getting-started/intro'},
+ collapsed: true,
+ items: [
+ 'getting-started/what-is-apache-doris',
+ 'getting-started/quick-start',
+ 'getting-started/before-you-start-the-poc',
+ ],
+},
```
-### 2.1 / 2.0 / 1.2 Historical Versions
+### 4.x / 3.x / 2.1 Released Versions
**1. Where to modify content**
+The released versions published on the website are listed in `versions.json`
in the root directory, currently 4.x, 3.x, and 2.1. The `version-1.2` and
`version-2.0` directories still exist in the repository, but they are not
listed in `versions.json` and are not built into the website.
+
| Version | English documentation location | Chinese documentation location |
| --- | --- | --- |
+| 4.x | `/versioned_docs/version-4.x` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x` |
+| 3.x | `/versioned_docs/version-3.x` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x` |
| 2.1 | `/versioned_docs/version-2.1` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1` |
-| 2.0 | `/versioned_docs/version-2.0` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0` |
-| 1.2 | `/versioned_docs/version-1.2` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2` |
```plain
.
@@ -287,13 +282,13 @@ The corresponding `sidebars.json` snippet:
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
│ │ ├── current
-│ │ ├── version-1.2
-│ │ ├── version-2.0
│ │ ├── version-2.1
+│ │ ├── version-3.x
+│ │ ├── version-4.x
├── versioned_docs
-│ ├── version-1.2
-│ ├── version-2.0
│ ├── version-2.1
+│ ├── version-3.x
+│ ├── version-4.x
```
**2. Documentation directory structure**
@@ -303,12 +298,12 @@ For each version, both Chinese and English documentation
are controlled by `vers
```plain
.
├── versioned_sidebars
-│ ├── version-1.2-sidebars.json
-│ ├── version-2.0-sidebars.json
-│ └── version-2.1-sidebars.json
+│ ├── version-2.1-sidebars.json
+│ ├── version-3.x-sidebars.json
+│ └── version-4.x-sidebars.json
```
-The sidebar hierarchy for each version is modified in essentially the same way
as for the Dev version, so no example is given here.
+The versioned sidebar files are JSON, but they use the same structure as
`sidebars.ts`. The sidebar hierarchy for each version is modified in
essentially the same way as for the Dev version, so no example is given here.
**3. Chinese translation for categories**
@@ -318,9 +313,9 @@ The Chinese translation files for the categories of each
version are located at
├── i18n
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
-│ │ ├── version-1.2.json
-│ │ ├── version-2.0.json
│ │ ├── version-2.1.json
+│ │ ├── version-3.x.json
+│ │ ├── version-4.x.json
```
The `label` translation for the Chinese documentation of each version is
essentially the same as for the Dev version, so no example is given here.
@@ -341,24 +336,24 @@ Example of the Chinese translation file:
```json
{
"version.label": {
- "message": "Next",
+ "message": "current",
"description": "The label for version current"
},
"sidebar.community.category.How to Contribute": {
- "message": "贡献指南",
+ "message": "参与贡献",
"description": "The label for category How to Contribute in sidebar
community"
},
- "sidebar.community.category.Release Process & Verification": {
- "message": "版本发布与校验",
- "description": "The label for category Release Process & Verification
in sidebar community"
+ "sidebar.community.category.Documentation Contribution": {
+ "message": "贡献文档",
+ "description": "The label for category Documentation Contribution in
sidebar community"
+ },
+ "sidebar.community.category.Release": {
+ "message": "版本与发布",
+ "description": "The label for category Release in sidebar community"
},
"sidebar.community.category.Design Documents": {
"message": "设计文档",
"description": "The label for category Design Documents in sidebar
community"
- },
- "sidebar.community.category.Developer Guide": {
- "message": "开发者手册",
- "description": "The label for category Developer Guide in sidebar
community"
}
}
```
diff --git
a/i18n/ko/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
b/i18n/ko/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
index 6ebeaa39c9d..b3c8ea0c001 100644
---
a/i18n/ko/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
+++
b/i18n/ko/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
@@ -52,7 +52,6 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
```plain
.
├── blog
-│ ├── 1.1 Release.md
│ ├── Annoucing.md
│ ├── jd.md
│ ├── meituan.md
@@ -66,37 +65,36 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
│ ├── ......
├── docs
│ ├── admin-manual
+│ │ ├── auth
│ │ ├── cluster-management
│ │ ├── config
│ │ ├── data-admin
-│ │ ├── http-actions
+│ │ ├── log-management
│ │ ├── maint-monitor
-│ │ ├── privilege-ldap
-│ │ ├── multi-tenant.md
-│ │ ├── optimization.md
-│ │ ├── query-profile.md
-│ │ └── sql-interception.md
-│ │ └── workload-group.md
+│ │ ├── open-api
+│ │ ├── system-tables
+│ │ ├── trouble-shooting
+│ │ ├── workload-management
+│ │ └── audit-plugin.md
│ ├── ......
├── i18n
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
│ │ ├── current
-│ │ ├── version-1.2
-│ │ ├── version-2.0
│ │ ├── version-2.1
+│ │ ├── version-3.x
+│ │ ├── version-4.x
│ │ ├── current.json
-│ │ ├── version-1.2.json
-│ │ ├── version-2.0.json
│ │ ├── version-2.1.json
-│ ├── docusaurus-plugin-content-docs-community
-│ └── local_build_docs.sh
+│ │ ├── version-3.x.json
+│ │ └── version-4.x.json
+│ └── docusaurus-plugin-content-docs-community
├── src
│ ├── components
│ │ ├── Icons
│ │ ├── More
-│ │ ├── PageBanner
-│ │ └── PageColumn
+│ │ ├── PageColumn
+│ │ └── PageHeader
│ ├── ......
├── static
│ ├── images
@@ -105,20 +103,19 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
│ └── js
│ └── redirect.js
├── versioned_docs
-│ ├── version-1.2
-│ ├── version-2.0
-│ └── version-2.1
+│ ├── version-2.1
+│ ├── version-3.x
+│ └── version-4.x
├── versioned_sidebars
-│ ├── version-1.2-sidebars.json
-│ ├── version-2.0-sidebars.json
-│ └── version-2.1-sidebars.json
-├── babel.config.js
+│ ├── version-2.1-sidebars.json
+│ ├── version-3.x-sidebars.json
+│ └── version-4.x-sidebars.json
├── build.sh
-├── buildVersions.sh
├── docusaurus.config.js
+├── local_build_docs.sh
├── package.json
├── README.md
-├── sidebars.json
+├── sidebars.ts
├── sidebarsCommunity.json
├── tsconfig.json
└── versions.json
@@ -131,13 +128,14 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
| `blog/` | 블로그 게시글 Markdown 파일 | 모든 버전에서 공유 |
| `community/` | 영어 커뮤니티 문서 | 모든 버전에서 공유 |
| `docs/` | 영어 최신 버전(Dev / Master) 문서 | 현재 메인 브랜치 |
-| `versioned_docs/version-X.X/` | 영어 이전 버전 문서 | 1.2 / 2.0 / 2.1 등 |
+| `versioned_docs/version-X.X/` | 영어 릴리스 버전 문서 | 4.x / 3.x /
2.1(`versions.json`에 나열됨) |
| `i18n/zh-CN/docusaurus-plugin-content-docs/current/` | 중국어 최신 버전 문서 | 현재 메인
브랜치 |
-| `i18n/zh-CN/docusaurus-plugin-content-docs/version-X.X/` | 중국어 이전 버전 문서 |
1.2 / 2.0 / 2.1 등 |
+| `i18n/zh-CN/docusaurus-plugin-content-docs/version-X.X/` | 중국어 릴리스 버전 문서 |
4.x / 3.x / 2.1(`versions.json`에 나열됨) |
| `i18n/zh-CN/docusaurus-plugin-content-docs-community/` | 중국어 커뮤니티 문서 | 모든
버전에서 공유 |
-| `sidebars.json` | 최신 버전 문서의 사이드바 | 중국어와 영어에서 공유 |
-| `versioned_sidebars/version-X.X-sidebars.json` | 이전 버전 문서의 사이드바 | 중국어와 영어에서
공유 |
+| `sidebars.ts` | 최신 버전 문서의 사이드바 | 중국어와 영어에서 공유 |
+| `versioned_sidebars/version-X.X-sidebars.json` | 릴리스 버전 문서의 사이드바 | 중국어와 영어에서
공유 |
| `sidebarsCommunity.json` | 커뮤니티 문서의 사이드바 | 모든 버전에서 공유 |
+| `versions.json` | 웹사이트에 게시되는 릴리스 버전 | 모든 릴리스 버전 |
| `static/images/` | 문서 이미지 리소스 | 모든 버전에서 공유 |
## 블로그 디렉터리 {#blog-directory}
@@ -152,7 +150,7 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
문서를 수정할 때는 변경 유형에 따라 여러 파일을 함께 수정해야 합니다:
-1. **기존 문서 내용 수정**: Master 브랜치의 최신 문서와 해당 버전 브랜치의 문서를 모두 업데이트해야 합니다(예: 2.1,
2.0, 1.2 또는 여러 버전).
+1. **기존 문서 내용 수정**: Master 브랜치의 최신 문서와 해당 릴리스 버전의 문서를 모두 업데이트해야 합니다(예: 4.x,
3.x, 2.1 또는 그중 여러 버전).
2. **새 문서 추가**: 새 Markdown 파일을 업로드하는 것과 함께 사이드바 파일에 새 문서의 링크 경로도 추가해야 합니다.
3. **새 문서 카테고리 추가**: 디렉터리 구조를 조정하는 것과 함께 새 카테고리의 중국어 번역도 추가해야 합니다.
@@ -161,8 +159,8 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
| 파일 유형 | 용도 | 예시 |
| --- | --- | --- |
| Markdown 파일 | 문서 본문 내용 | `docs/admin-manual/xxx.md` |
-| 사이드바 파일 | 디렉터리 구조 관리 | `sidebars.json` / `version-2.1-sidebars.json` |
-| 번역 파일 | 중국어 문서에서 카테고리가 표시되는 방식 관리 | `current.json` / `version-2.1.json` |
+| 사이드바 파일 | 디렉터리 구조 관리 | `sidebars.ts` / `version-4.x-sidebars.json` |
+| 번역 파일 | 중국어 문서에서 카테고리가 표시되는 방식 관리 | `current.json` / `version-4.x.json` |
:::caution 참고
@@ -192,38 +190,36 @@ PR 제출 절차는 다음 문서도 참고할 수 있습니다:
**2. 문서 디렉터리 구조**
-Dev 버전의 중국어 및 영어 문서는 모두 루트 디렉터리의 `sidebars.json`으로 관리합니다.
-
-`sidebars.json` 예시:
-
-```json
-{
- "docs": [
- {
- "type": "category",
- "label": "Getting Started",
- "items": [
- "get-starting/quick-start",
- "get-starting/what-is-apache-doris"
- ]
- },
- {
- "type": "category",
- "label": "Install and Deploy",
- "items": [
- "install/standard-deployment",
- {
- "type": "category",
- "label": "Docker Deployment",
- "items": [
- "install/construct-docker/build-docker-image",
- "install/construct-docker/run-docker-cluster"
- ]
- }
- ......
- }
- ]
- }
+Dev 버전의 중국어 및 영어 문서는 모두 루트 디렉터리의 `sidebars.ts`로 관리합니다.
+
+`sidebars.ts` 예시:
+
+```ts
+const sidebars: SidebarsConfig = {
+ docs: [
+ {
+ type: 'category',
+ label: 'Get Started',
+ collapsible: false,
+ collapsed: false,
+ items: [
+ {
+ type: 'category',
+ label: 'Getting Started',
+ link: {type: 'doc', id: 'getting-started/intro'},
+ collapsed: true,
+ items: [
+ 'getting-started/what-is-apache-doris',
+ 'getting-started/quick-start',
+ 'getting-started/before-you-start-the-poc',
+ ],
+ },
+ ......
+ ],
+ },
+ ......
+ ],
+};
```
**3. 카테고리의 중국어 번역**
@@ -232,8 +228,8 @@ Dev 버전 카테고리의 중국어 번역 파일은 `i18n/zh-CN/docusaurus-plu
"시작하기" 카테고리를 예로 들면 다음과 같습니다:
-- `sidebar.docs.category.Getting Started`는 `label` 계층 구조에 대응합니다. 이 구조는
`sidebars.json`에 정의되어 있습니다.
-- 형식은 다음과 같습니다: `sidebar` + `.` + `docs` + `.` + `[type]` + `[label]`.
+- `sidebar.docs.category.Getting Started`는 `label` 계층 구조에 대응합니다. 이 구조는
`sidebars.ts`에 정의되어 있습니다.
+- 형식은 다음과 같습니다: `sidebar` + `.` + `docs` + `.` + `[type]` + `.` + `[label]`.
```json
{
@@ -249,34 +245,33 @@ Dev 버전 카테고리의 중국어 번역 파일은 `i18n/zh-CN/docusaurus-plu
}
```
-이에 대응하는 `sidebars.json` 일부는 다음과 같습니다:
+이에 대응하는 `sidebars.ts` 일부는 다음과 같습니다:
-```json
+```ts
{
- "docs": [
- {
- "type": "category",
- "label": "Getting Started",
- "items": [
- "get-starting/quick-start",
- "get-starting/what-is-apache-doris"
- ]
- },
- ......
- }
- ]
- }
+ type: 'category',
+ label: 'Getting Started',
+ link: {type: 'doc', id: 'getting-started/intro'},
+ collapsed: true,
+ items: [
+ 'getting-started/what-is-apache-doris',
+ 'getting-started/quick-start',
+ 'getting-started/before-you-start-the-poc',
+ ],
+},
```
-### 2.1 / 2.0 / 1.2 이전 버전 {#21--20--12-historical-versions}
+### 4.x / 3.x / 2.1 릴리스 버전 {#4x--3x--21-released-versions}
**1. 내용 수정 위치**
+웹사이트에 게시되는 릴리스 버전은 루트 디렉터리의 `versions.json`에 나열되어 있으며, 현재는 4.x, 3.x, 2.1입니다.
저장소에는 `version-1.2`와 `version-2.0` 디렉터리가 아직 남아 있지만, 이 디렉터리는 `versions.json`에
나열되어 있지 않으며 웹사이트에 빌드되지 않습니다.
+
| 버전 | 영어 문서 위치 | 중국어 문서 위치 |
| --- | --- | --- |
+| 4.x | `/versioned_docs/version-4.x` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x` |
+| 3.x | `/versioned_docs/version-3.x` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x` |
| 2.1 | `/versioned_docs/version-2.1` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1` |
-| 2.0 | `/versioned_docs/version-2.0` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0` |
-| 1.2 | `/versioned_docs/version-1.2` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2` |
```plain
.
@@ -287,13 +282,13 @@ Dev 버전 카테고리의 중국어 번역 파일은 `i18n/zh-CN/docusaurus-plu
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
│ │ ├── current
-│ │ ├── version-1.2
-│ │ ├── version-2.0
│ │ ├── version-2.1
+│ │ ├── version-3.x
+│ │ ├── version-4.x
├── versioned_docs
-│ ├── version-1.2
-│ ├── version-2.0
│ ├── version-2.1
+│ ├── version-3.x
+│ ├── version-4.x
```
**2. 문서 디렉터리 구조**
@@ -303,12 +298,12 @@ Dev 버전 카테고리의 중국어 번역 파일은 `i18n/zh-CN/docusaurus-plu
```plain
.
├── versioned_sidebars
-│ ├── version-1.2-sidebars.json
-│ ├── version-2.0-sidebars.json
-│ └── version-2.1-sidebars.json
+│ ├── version-2.1-sidebars.json
+│ ├── version-3.x-sidebars.json
+│ └── version-4.x-sidebars.json
```
-각 버전의 사이드바 계층 구조를 수정하는 방법은 Dev 버전과 기본적으로 같으므로 여기서는 예시를 생략합니다.
+릴리스 버전의 사이드바 파일은 JSON 형식이지만 `sidebars.ts`와 같은 구조를 사용합니다. 각 버전의 사이드바 계층 구조를
수정하는 방법은 Dev 버전과 기본적으로 같으므로 여기서는 예시를 생략합니다.
**3. 카테고리의 중국어 번역**
@@ -318,9 +313,9 @@ Dev 버전 카테고리의 중국어 번역 파일은 `i18n/zh-CN/docusaurus-plu
├── i18n
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
-│ │ ├── version-1.2.json
-│ │ ├── version-2.0.json
│ │ ├── version-2.1.json
+│ │ ├── version-3.x.json
+│ │ ├── version-4.x.json
```
각 버전의 중국어 문서에 대한 `label` 번역 방법은 Dev 버전과 기본적으로 같으므로 여기서는 예시를 생략합니다.
@@ -341,24 +336,24 @@ Dev 버전 카테고리의 중국어 번역 파일은 `i18n/zh-CN/docusaurus-plu
```json
{
"version.label": {
- "message": "Next",
+ "message": "current",
"description": "The label for version current"
},
"sidebar.community.category.How to Contribute": {
- "message": "贡献指南",
+ "message": "参与贡献",
"description": "The label for category How to Contribute in sidebar
community"
},
- "sidebar.community.category.Release Process & Verification": {
- "message": "版本发布与校验",
- "description": "The label for category Release Process & Verification
in sidebar community"
+ "sidebar.community.category.Documentation Contribution": {
+ "message": "贡献文档",
+ "description": "The label for category Documentation Contribution in
sidebar community"
+ },
+ "sidebar.community.category.Release": {
+ "message": "版本与发布",
+ "description": "The label for category Release in sidebar community"
},
"sidebar.community.category.Design Documents": {
"message": "设计文档",
"description": "The label for category Design Documents in sidebar
community"
- },
- "sidebar.community.category.Developer Guide": {
- "message": "开发者手册",
- "description": "The label for category Developer Guide in sidebar
community"
}
}
```
diff --git
a/i18n/ko/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/automatic-service-start.md
b/i18n/ko/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/automatic-service-start.md
index 292b8962deb..244b857e0ff 100644
---
a/i18n/ko/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/automatic-service-start.md
+++
b/i18n/ko/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/automatic-service-start.md
@@ -115,7 +115,7 @@ RestartSec=30
StartLimitInterval=120
StartLimitBurst=3
KillMode=none
-ExecStart=/home/doris/fe/bin/start_fe.sh --daemon0
+ExecStart=/home/doris/fe/bin/start_fe.sh --daemon
ExecStop=/home/doris/fe/bin/stop_fe.sh
[Install]
diff --git
a/i18n/ko/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
b/i18n/ko/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
index eb51bb09c95..438668afac4 100644
---
a/i18n/ko/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
+++
b/i18n/ko/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
@@ -432,9 +432,9 @@ REST Namespace는 테이블 버전을 직접 관리할 수 있습니다(`managed
제한 사항:
-- Doris는 `DescribeTable`이 반환한 `table_uri`의 데이터세트를 읽으며, `table_uri`가 없으면
`location`에서 읽습니다. 어느 쪽이든 완전한 스토리지 URI여야 합니다. `location`이 비어 있거나, 함께 반환된
`table_uri`가 다른 위치를 가리키면 쿼리는 오류로 실패하고 아무것도 읽지 않습니다. 단, 사전 서명된 자격 증명과 같은 쿼리 문자열
차이는 제외합니다. `s3+ddb` URI도 거부됩니다. 해당 DynamoDB 커밋 핸들러가 읽기 시 버전을 기록하고 확정하기 때문입니다.
Doris는 관리형 테이블을 캐시하지 않고 읽을 때마다 describe를 수행하며, FE와 BE는 해당 describe가 반환한 위치와
스토리지 구성으로 읽습니다.
+- Doris는 `table_uri`(`DescribeTable`이 반환한 값)가 가리키는 데이터세트를 읽고, `location`은
`table_uri`가 없을 때 대신 사용합니다. 어느 쪽이든 완전한 스토리지 URI여야 합니다. `location`이 비어 있거나, 함께
반환된 `table_uri`가 다른 위치를 가리키면 쿼리는 오류로 실패하고 아무것도 읽지 않습니다. 단, 사전 서명된 자격 증명과 같은 쿼리
문자열 차이는 제외합니다. `s3+ddb` URI도 거부됩니다. 해당 DynamoDB 커밋 핸들러가 읽기 시 버전을 기록하고 확정하기
때문입니다. Doris는 관리형 테이블을 캐시하지 않고 읽을 때마다 describe를 수행하며, FE와 BE는 해당 describe가 반환한
위치와 스토리지 구성으로 읽습니다.
- Doris는 테이블 디렉터리의 정규 경로인 `_versions/<u64::MAX - version>.manifest`에서 버전 번호로
버전을 읽습니다. 브랜치의 경우 `tree/<branch>/` 아래에서 읽으며, Lance의 이전 명명 규칙에서는
`_versions/<version>.manifest`를 사용합니다. Namespace가 선택한 버전에 대해 기록한 manifest는 해당
경로이거나 그 옆의 스테이징된 manifest(`<canonical path>-<id>`)여야 합니다. `FOR TIME AS OF`에서는
해당 `main` 또는 브랜치에 기록된 모든 버전의 manifest도 이 조건을 충족해야 합니다. 커밋 시간이 선택을 결정하기 때문입니다.
다른 위치에 기록된 버전은 읽을 수 없습니다. 쿼리가 오류로 실패하며 기록된 경로와 정규 경로를 표시합니다. 쿼리 실행 중 Namespace가
테이블을 이동해도 같은 방식으로 실패할 수 있으며, 다시 시도하면 성공합니다.
-- Namespace가 스테이징된 manifest에만 기록하고 정규 manifest는 존재하지 않는 버전은 읽을 수 없습니다. 커밋이
확정되지 않았거나 정리 작업으로 버전이 제거된 경우입니다. 쿼리는 실패하며 두 원인을 모두 표시합니다. 해당 `main` 또는 브랜치에 대한
`FOR TIME AS OF`는 그 버전이 적용되었을 수 있는 모든 타임스탬프에서 실패합니다. 커밋 시간을 알 수 없기 때문입니다. 최신
버전의 경우에는 writer 또는 Namespace를 사용하는 다른 리더가 이를 확정할 때까지 모든 타임스탬프에서 실패합니다. 이 경우
`FOR VERSION AS OF` 없이 테이블을 읽거나 스키마를 로딩하는 작업도 실패합니다. Lance 자체 Namespace 구현은 버전을
기록하기 전에 확정하므로, 미확정 버전은 커밋이 중단되었거나 스테이징된 manifest를 기록하는 Namespace에서만 나타납니다.
Doris는 테이블을 읽는 동�
�� 절대 쓰지 않습니다.
+- Namespace가 스테이징된 manifest에만 기록하고 정규 manifest는 존재하지 않는 버전은 읽을 수 없습니다. 커밋이
확정되지 않았거나 정리 작업으로 버전이 제거된 경우입니다. 쿼리는 실패하며 두 원인을 모두 표시합니다. `FOR TIME AS OF`를 해당
`main` 또는 브랜치에 사용하면 그 버전이 적용되었을 수 있는 모든 타임스탬프에서 실패합니다. 커밋 시간을 알 수 없기 때문입니다. 최신
버전의 경우에는 writer 또는 Namespace를 사용하는 다른 리더가 이를 확정할 때까지 모든 타임스탬프에서 실패합니다. 이 경우
`FOR VERSION AS OF` 없이 테이블을 읽거나 스키마를 로딩하는 작업도 실패합니다. Lance 자체 Namespace 구현은 버전을
기록하기 전에 확정하므로, 미확정 버전은 커밋이 중단되었거나 스테이징된 manifest를 기록하는 Namespace에서만 나타납니다.
Doris는 테이블을 읽�
� 동안 절대 쓰지 않습니다.
## Lance 인덱스 조회 {#inspect-lance-indexes}
@@ -455,7 +455,7 @@ Doris는 실행 시점의 최신 데이터세트 스냅샷에서 인덱스 메
| `Seq_in_index` | 인덱스에서 열의 위치이며 `1`부터 시작합니다. 여러 필드의 인덱스는 필드마다 한 행을 생성합니다. |
| `Column_name` | 인덱싱된 필드입니다. 중첩 필드의 인덱스는 필드 경로를 `.`으로 연결하여 표시하며, 문자, 숫자 및 `_`
이외의 문자가 포함된 경로 세그먼트는 백틱으로 묶습니다. 예: `` attributes.`child.with.dot` ``. |
| `Index_type` | Lance SDK가 보고하는 인덱스 유형입니다. 예: `BTree`, `INVERTED`,
`IVF_FLAT`, `IVF_SQ`, `IVF_PQ`, `IVF_HNSW_FLAT`, `IVF_HNSW_SQ`, `IVF_HNSW_PQ`. |
-| `Properties` | 고정된 인덱스 상세 정보 집합을 담은 JSON 객체입니다. 최상위에는 `metric_type`과
`target_partition_size`, `compression` 아래에는 `type`, `num_bits`,
`num_sub_vectors`, `rotation_type`, `hnsw` 아래에는 `construction_ef`,
`max_connections`, `max_level`이 있습니다. 키는 정렬되며, 인덱스 상세 정보에 이러한 필드가 하나도 없으면 값은
`{}`입니다. |
+| `Properties` | 고정된 인덱스 상세 정보 집합을 담은 JSON 객체입니다. `metric_type`과
`target_partition_size`는 최상위에, `type`, `num_bits`, `num_sub_vectors`,
`rotation_type`은 `compression` 아래에, `construction_ef`, `max_connections`,
`max_level`은 `hnsw` 아래에 있습니다. 키는 정렬되며, 인덱스 상세 정보에 이러한 필드가 하나도 없으면 값은 `{}`입니다. |
다음 행은 `IVF_PQ` 벡터 인덱스와 중첩 필드의 `BTree` 인덱스를 보여줍니다.
@@ -623,9 +623,9 @@ WHERE active
### 배열 레이블 조건자 {#array-label-predicates}
-Apache Doris 4.1.5부터 배열 레이블 푸시다운은 직접적인 Lance `list<utf8>` 열과 `NULL`이 아닌 문자열
리터럴에 대한 `array_contains`를 지원합니다. 이전 빌드에서는 이러한 조건이 Doris에 남을 수 있습니다. 이 최적화에 의존하기
전에 `EXPLAIN`을 확인하세요. `NULL` 배열은 여전히 `NULL`을 반환하고, 빈 배열은 일치하지 않으며, 중복 레이블이 있어도
결과 행이 중복되지 않습니다.
+Apache Doris 4.1.5부터 배열 레이블 푸시다운은 `array_contains`를 지원합니다. 대상은 직접적인 Lance
`list<utf8>` 열과 `NULL`이 아닌 문자열 리터럴입니다. 이전 빌드에서는 이러한 조건이 Doris에 남을 수 있습니다. 이
최적화에 의존하기 전에 `EXPLAIN`을 확인하세요. `NULL` 배열은 여전히 `NULL`을 반환하고, 빈 배열은 일치하지 않으며, 중복
레이블이 있어도 결과 행이 중복되지 않습니다.
-`id` 열과 `list<utf8>` 타입의 `labels` 열이 있는 Lance 테이블의 예제입니다.
+`id` 열과 `labels` 열(`list<utf8>` 타입)이 있는 Lance 테이블의 예제입니다.
```sql
EXPLAIN
@@ -653,8 +653,8 @@ WHERE array_contains(labels, 'red')
| 근거 | 의미 |
|---|---|
-| `EXPLAIN`의 `lancePushdownPredicate` | Lance로 전송되는 조건입니다. 남은 `predicates:`
조건은 Doris가 평가합니다. |
-| `EXPLAIN`의 `lanceScalarIndexScan=SEGMENT` 및 `lanceGroupingIndex` | 스칼라 세그먼트
스캔이 계획되었음을 나타내며 선택된 논리 인덱스를 식별합니다. 이것만으로 실행 시 인덱스를 사용했다고 입증할 수는 없습니다. |
+| `lancePushdownPredicate`(`EXPLAIN` 출력) | Lance로 전송되는 조건입니다. 남은 `predicates:`
조건은 Doris가 평가합니다. |
+| `lanceScalarIndexScan=SEGMENT` 및 `lanceGroupingIndex`(`EXPLAIN` 출력) | 스칼라
세그먼트 스캔이 계획되었음을 나타내며 선택된 논리 인덱스를 식별합니다. 이것만으로 실행 시 인덱스를 사용했다고 입증할 수는 없습니다. |
| Profile의 `LanceScalarIndexSegmentsSearched` | 계측된 스칼라 세그먼트 경로에서 실제로 수행된
검색입니다. |
| Profile의 `LanceScalarIndexCandidateRows` | 해당 경로가 보고한 후보 행이며, 최종 결과 행과 같지는
않을 수 있습니다. 일부 `NOT` 표현식과 같은 여집합 마스크는 후보 수를 보고하지 않을 수 있습니다. |
| Profile의 `LanceScalarIndexSegmentFallbacks` | 계획된 스칼라 세그먼트 경로에서 다른 경로로 대체된
작업입니다. |
@@ -679,11 +679,11 @@ JOIN internal.demo.allowed_users a
| IN Filter | `column IN (...)` |
| Min/Max Filter | `column >= min_value`, `column <= max_value` 또는 둘 다 |
-Runtime Filter의 열과 값은 Lance SQL이 지원하는 스칼라 타입으로 안전하게 변환할 수 있어야 합니다. 다른 Runtime
Filter 유형, NULL이 포함된 IN Filter, 안전하게 변환할 수 없는 데이터 타입이나 값은 푸시다운하지 않습니다. 푸시다운되지
않은 Runtime Filter도 Doris가 계속 평가하므로 쿼리 정확성은 유지됩니다. Lance에서 조기에 필터링하여 얻는 성능 이점만
사라집니다.
+Runtime Filter의 열과 값은 Lance SQL이 지원하는 스칼라 타입으로 안전하게 변환할 수 있어야 합니다. 다른 Runtime
Filter 유형, `NULL`이 포함된 IN Filter, 안전하게 변환할 수 없는 데이터 타입이나 값은 푸시다운하지 않습니다. 푸시다운되지
않은 Runtime Filter도 Doris가 계속 평가하므로 쿼리 정확성은 유지됩니다. Lance에서 조기에 필터링하여 얻는 성능 이점만
사라집니다.
Lance Scanner를 생성하기 전에 준비된 Runtime Filter만 해당 Scanner의 푸시다운 조건에 포함할 수 있습니다.
나중에 도착한 Runtime Filter도 Doris가 평가하지만, 이미 생성된 Scanner에는 푸시다운되지 않을 수 있습니다.
-Runtime Filter 조건은 일반 SQL 조건자에서 생성한 Substrait 조건과 결합되며, 어느 한쪽이 다른 쪽을 대체하지
않습니다. `EXPLAIN`의 `runtime filters` 항목은 계획된 Runtime Filter를 보여줍니다. Runtime
Filter가 하나 이상 푸시다운되면 Runtime Profile의 `LanceRuntimeFilterPushedIds`와
`LanceRuntimeFilterSkippedIds`가 푸시다운된 Filter ID와 건너뛴 Filter ID를 식별합니다.
+Runtime Filter 조건은 일반 SQL 조건자에서 생성한 Substrait 조건과 결합되며, 어느 한쪽이 다른 쪽을 대체하지
않습니다. `runtime filters` 항목(`EXPLAIN` 출력)은 계획된 Runtime Filter를 보여줍니다. Runtime
Filter가 하나 이상 푸시다운되면 Runtime Profile의 `LanceRuntimeFilterPushedIds`와
`LanceRuntimeFilterSkippedIds`가 푸시다운된 Filter ID와 건너뛴 Filter ID를 식별합니다.
현재 Runtime Filter 푸시다운은 일반 Lance 테이블 스캔에만 적용됩니다. `vector_search()` 또는 전문 검색이
후보를 생성하는 동안에는 사용하지 않습니다.
@@ -809,7 +809,7 @@ ORDER BY _distance ASC, user_id;
`vector_search()`의 관계 스키마에는 Lance 원본 테이블의 모든 열과, 최근접 이웃 쿼리를 위해 Lance Scanner가
생성한 `_distance` 열이 포함됩니다. 최종 SQL 결과에는 `SELECT`로 프로젝션한 열만 포함됩니다. Doris는
`_distance`를 `FLOAT`로 노출합니다. 이는 일반적인 유사도 점수가 아니라 거리이며, 값이 작을수록 두 벡터가 가깝다는 뜻입니다.
원본 테이블에는 `_distance`라는 열이 이미 있어서는 안 됩니다. SQL 관계는 최종 표시 순서를 보장하지 않으므로, 결정적인 최근접
이웃 순서가 필요하면 `ORDER BY _distance ASC`를 명시하세요. 거리가 같은 행의 순서를 결정하도록 고유한 열을 추가하는 것이
좋습니다.
-`table`은 정확히 세 부분의 `catalog.database.table` 이름으로 파싱되어야 합니다. 다단계 Lance
Namespace는 `.`이 포함된 하나의 Doris 데이터베이스 이름에 매핑되므로 데이터베이스 부분을 백틱으로 묶으세요. 예를 들어
`doris.analytics` Namespace의 `items` 테이블에는 다음 값을 사용합니다.
+`table`은 정확히 세 부분의 `catalog.database.table` 이름으로 파싱되어야 합니다. 다단계 Lance
Namespace는 `.`이 포함된 하나의 Doris 데이터베이스 이름에 매핑되므로 데이터베이스 부분을 백틱으로 묶으세요. 예를 들어
`items` 테이블(`doris.analytics` Namespace)에는 다음 값을 사용합니다.
```sql
"table" = "lance_catalog.`doris.analytics`.items"
@@ -826,7 +826,7 @@ ORDER BY _distance ASC, user_id;
| `query_vector` | 예 | - | 단일 벡터 열의 경우 JSON 숫자 배열, 다중 벡터 열의 경우 비어 있지 않은 JSON
행렬입니다. 각 하위 벡터의 차원은 열과 일치해야 하며, 각 값은 유한하고 요소 타입으로 표현할 수 있어야 합니다. |
| `top_k` | 아니요 | `10` | `offset`만큼 건너뛴 후 반환할 결과 수입니다. 양의 정수여야 합니다. |
| `offset` | 아니요 | `0` | 벡터 검색 내부에서 건너뛸 최근접 이웃 수입니다. 음이 아닌 정수여야 합니다. `top_k +
offset`은 부호 없는 32비트 정수의 최댓값을 초과할 수 없습니다. |
-| `metric` | 아니요 | `l2` | 거리 메트릭: `l2`, `cosine`, `dot` 또는 `hamming`.
`dot_product`는 `dot`의 별칭입니다. `uint8` 벡터는 `hamming`만 지원하며, 현재 지원되는 나머지 벡터 요소 타입은
`l2`, `cosine`, `dot`을 지원합니다. `cosine`, `dot` 또는 `hamming` 인덱스를 쿼리할 때는
`metric`을 명시적으로 설정하세요. 정수 다중 벡터 열과 다중 벡터 `hamming`은 지원하지 않습니다. |
+| `metric` | 아니요 | `l2` | 거리 메트릭: `l2`, `cosine`, `dot` 또는 `hamming`.
`dot_product`는 `dot`의 별칭입니다. `uint8` 벡터는 `hamming`만 지원하며, 현재 지원되는 나머지 벡터 요소 타입은
`l2`, `cosine`, `dot`을 지원합니다. `metric`은 `cosine`, `dot` 또는 `hamming` 인덱스를 쿼리할 때
명시적으로 설정하세요. 정수 다중 벡터 열과 다중 벡터 `hamming`은 지원하지 않습니다. |
| `distance_lower_bound` | 아니요 | 제한 없음 | 단일 벡터 검색의 포함 하한 거리입니다. 유한한 `FLOAT`여야
합니다. |
| `distance_upper_bound` | 아니요 | 제한 없음 | 단일 벡터 검색의 미포함 상한 거리입니다. 유한한 `FLOAT`여야
합니다. 양쪽 경계를 모두 설정하면 `FLOAT`로 변환한 후 하한이 더 작아야 합니다. |
| `filter` | 아니요 | - | Lance가 평가하는 Lance SQL 조건입니다. 실행 시점은 `prefilter`로 제어합니다.
|
@@ -843,7 +843,7 @@ ORDER BY _distance ASC, user_id;
반경 쿼리에는 `distance_upper_bound`를 설정하고, 구간 `[lower, upper)`에는 양쪽 경계를 함께 설정하세요.
생략한 경계에는 제한이 없습니다. 거리는 선택한 메트릭을 사용합니다. `l2`는 **유클리드 거리의 제곱**이므로 기하학적 반경 `r`은 상한
`r * r`에 해당합니다. 음수 경계도 허용되며, 이는 `dot`과 같은 메트릭에 유용합니다. 저장된 벡터가 Float64를 사용해도 경계는
`FLOAT` 정밀도를 사용합니다. 유한하지 않은 경계, 오버플로, 같은 경계 및 역전된 구간은 거부됩니다.
-예를 들어 기존 Lance Catalog 테이블인 `lance_catalog.default.items`에 `user_id`와 3차원
Float32 `embedding` 열이 있다고 가정합니다.
+예를 들어 기존 Lance Catalog 테이블인 `lance_catalog.default.items`에 `user_id`와 삼차원
Float32 `embedding` 열이 있다고 가정합니다.
| user_id | embedding | `[0, 0, 0]`까지의 L2 거리 제곱 |
|---|---|---|
@@ -874,7 +874,7 @@ ORDER BY _distance;
+---------+-----------+
```
-하한을 제거하면 행 1도 반환됩니다. 상한 `0`만 사용하면 아무 행도 반환되지 않습니다. `prefilter=true`이면
`filter`가 벡터 검색 전에 후보를 제한하고, 기본값인 `prefilter=false`이면 후보 생성 후에 필터링합니다.
`offset`은 거리 범위를 적용한 후 결과를 건너뜁니다. 출력 스키마는 바뀌지 않으며, 테이블 열에 `FLOAT` 타입의
`_distance`가 추가됩니다. `EXPLAIN`은 `lanceDistanceRange=[1.0, 4.0)`를 표시합니다.
+하한을 제거하면 행 1도 반환됩니다. 상한 `0`만 사용하면 아무 행도 반환되지 않습니다. `prefilter=true`이면
`filter`가 벡터 검색 전에 후보를 제한하고, 기본값인 `prefilter=false`이면 후보 생성 후에 필터링합니다.
`offset`은 거리 범위를 적용한 후 결과를 건너뜁니다. 출력 스키마는 바뀌지 않으며, 테이블 열에 `_distance`(`FLOAT`
타입)가 추가됩니다. `EXPLAIN`은 `lanceDistanceRange=[1.0, 4.0)`를 표시합니다.
거리 경계는 준비된 문에서 `?` 매개변수를 지원합니다. 각 실행은 자체 경계 값을 검증하고 사용하며, NULL 경계는 거부됩니다. 한쪽에
제한을 두지 않으려면 해당 속성을 생략하세요.
@@ -923,7 +923,7 @@ ORDER BY _distance;
쿼리의 `metric`은 인덱스를 구축할 때 사용한 메트릭과 일치해야 합니다. 그렇지 않으면 요청한 메트릭이 해당 열 타입에서 지원되는 경우
Doris는 Flat Search를 사용합니다. 결과는 정확하지만 벡터를 직접 스캔해야 하므로 일반적으로 성능이 낮아집니다.
-`metric`을 생략하면 Doris는 인덱스 선택 시 이를 `l2`로 취급합니다. 따라서 `cosine`, `dot` 또는
`hamming`으로 구축한 인덱스를 사용할 때는 `metric`을 명시적으로 설정하세요. 예를 들어 `uint8` 벡터 인덱스에는
`"metric" = "hamming"`이 필요합니다. 그렇지 않으면 지원하지 않는 `l2` 메트릭을 사용하여 쿼리가 실패합니다.
+`metric`을 생략하면 Doris는 인덱스 선택 시 이를 `l2`로 취급합니다. 따라서 `metric`은 `cosine`, `dot`
또는 `hamming`으로 구축한 인덱스를 사용할 때 명시적으로 설정하세요. 예를 들어 `uint8` 벡터 인덱스에는 `"metric" =
"hamming"`이 필요합니다. 그렇지 않으면 지원하지 않는 `l2` 메트릭을 사용하여 쿼리가 실패합니다.
`EXPLAIN`으로 인덱스 사용 여부를 확인하세요. `lanceSearchIndexSegments` 값이 `0`보다 크면 인덱스 검색을
나타내고, `0`이면 Flat Search를 나타냅니다.
@@ -1104,7 +1104,7 @@ Lance Cache는 인덱스, 메타데이터 및 데이터 파일 내용을 재사
|---|---|---|
| 인덱스 캐시 | BE 메모리 | 로딩된 Lance 인덱스 내용으로, 반복적인 인덱스 로딩을 줄입니다. |
| 메타데이터 캐시 | BE 메모리 | Lance 리더가 사용하는 메타데이터로, 반복 읽기와 파싱을 줄입니다. |
-| 데이터 캐시 | BE 로컬 디스크. 메모리 계층의 크기는 읽기 블록 하나에 해당 | Dataset의 `data/` 디렉터리 바로 아래에서
`.lance`로 끝나는 파일의 데이터를 블록 단위로 캐시합니다. |
+| 데이터 캐시 | BE 로컬 디스크. 메모리 계층의 크기는 읽기 블록 하나에 해당 | `.lance`로 끝나는 파일(Dataset의
`data/` 디렉터리 바로 아래)의 데이터를 블록 단위로 캐시합니다. |
데이터 캐시는 Lance 리더 내부에서 Foyer를 사용하며, 자체 디렉터리와 용량은 아래의 `lance_*` BE 매개변수로 구성합니다.
Doris의 일반 File Cache 디렉터리나 용량 설정은 사용하지 않습니다. 인덱스 파일, manifest 및 삭제 파일은 이 디스크
데이터 캐시를 거치지 않으며 기존 Lance 읽기 및 캐시 경로를 계속 사용합니다.
@@ -1224,7 +1224,7 @@ TVF를 사용하기 전에 Lance SDK 또는 다른 Lance writer로 대상 문자
### 구문 및 예제 {#syntax-and-example-1}
-다음 쿼리는 범주가 `storage`인 문서 중에서 `lance database`를 검색한 후, `published = true`를
Doris Post-filter로 적용합니다.
+다음 쿼리는 `lance database`를 검색하되 범주가 `storage`인 문서로 한정한 후, `published = true`를
Doris Post-filter로 적용합니다.
```sql
SELECT document_id, title, _score
@@ -1268,7 +1268,7 @@ ORDER BY _score DESC, document_id;
| 매개변수 | 필수 여부 | 기본값 | 설명 |
|---|---|---|---|
| `table` | 예 | - | Lance Catalog의 테이블을 식별하는, 세 부분으로 구성된 정규화된
`catalog.database.table` 이름입니다. 다단계 Namespace가 `.`이 포함된 데이터베이스 이름에 매핑되면 데이터베이스
부분을 백틱으로 묶으세요. 사용자에게 해당 테이블의 `SELECT` 권한이 있어야 합니다. |
-| `column` | 예 | - | FTS 역색인이 있는 문자열 열입니다. Doris `TEXT`에 매핑되는 Arrow `utf8`와
`large_utf8`를 지원합니다. |
+| `column` | 예 | - | FTS 역색인이 있는 문자열 열입니다. Arrow `utf8`와 `large_utf8`를 지원하며, 이
타입은 Doris `TEXT`에 매핑됩니다. |
| `query` | 예 | - | 비어 있지 않은 검색 텍스트입니다. FTS 인덱스를 생성할 때 구성한 토크나이저로 처리합니다. |
| `query_type` | 아니요 | `match` | 쿼리 유형입니다. 유효한 값은 `match`와 `phrase`입니다. |
| `operator` | 아니요 | `or` | Match 쿼리 전용입니다. `or`는 하나 이상의 쿼리 용어가 일치해야 하고,
`and`는 모든 쿼리 용어가 일치해야 합니다. Phrase 쿼리에서는 이 매개변수를 설정할 수 없습니다. |
@@ -1337,7 +1337,7 @@ ORDER BY _score DESC;
- `version`과 `timestamp`는 함께 사용할 수 없으며, `tag`는 나머지 세 매개변수 중 어느 것과도 함께 사용할 수
없습니다. 매개변수를 빈 값으로 설정하면 무시되지 않고 오류가 발생합니다.
- 출력 스키마, 검색 열, 벡터 인덱스 및 FTS 인덱스 메타데이터, Fragment는 모두 선택한 스냅샷에서 가져옵니다. 후보 생성,
필터링, Top-K 및 두 단계 읽기는 모두 해당 스냅샷을 읽습니다. 과거 버전은 그 버전에 커밋된 인덱스를 사용합니다. 벡터 인덱스 생성 전
버전은 Flat Search를 사용하고, FTS 인덱스 생성 전 버전은 `full_text_search()`로 검색할 수 없으며,
`coverage_mode`는 해당 버전의 Fragment를 검사합니다.
- 선택할 수 없거나 인덱스 파일이 누락된 스냅샷은 오류가 발생합니다. 검색은 최신 버전으로 대체되지 않습니다. Lance의 정리 작업으로
제거된 버전은 찾을 수 없다고 보고됩니다. 태그로 유지되는 버전은 정리 작업 중에도 인덱스 파일을 유지합니다. 다른 방식으로 삭제된 인덱스
파일은 실행 시 실패를 일으키며, 오류에 데이터세트 버전이 표시됩니다.
-- 준비된 문의 모든 `EXECUTE`를 포함하여 실행할 때마다 스냅샷을 다시 선택하므로, 최신 버전, 미래 시점, 브랜치 및 이동된 태그는
매번 다른 버전을 선택할 수 있습니다. 네 매개변수는 상수여야 합니다. 준비된 문에서 `vector_search()`는
`query_vector`, `top_k`, `offset`, `filter`에만 자리표시자(`?`)를 허용하고,
`full_text_search()`는 허용하지 않습니다.
+- 준비된 문의 모든 `EXECUTE`를 포함하여 실행할 때마다 스냅샷을 다시 선택하므로, 최신 버전, 미래 시점, 브랜치 및 이동된 태그는
매번 다른 버전을 선택할 수 있습니다. 네 매개변수는 상수여야 합니다. 준비된 문에서 `vector_search()`는 자리표시자(`?`)를
`query_vector`, `top_k`, `offset`, `filter`에만 허용하고, `full_text_search()`는 허용하지
않습니다.
- 각 검색 관계는 자체 스냅샷을 선택합니다. 한 문에서 같은 테이블에 대한 두 관계, 예를 들어 `vector_search()`와 테이블
자체를 조인하는 경우, 그 사이에 새 버전이 커밋되면 서로 다른 버전을 읽을 수 있습니다. 같은 버전을 읽으려면 양쪽 모두 고정하세요. 검색
함수에는 `version`, 테이블에는 `FOR VERSION AS OF`를 사용합니다.
- `CREATE TABLE AS SELECT`는 새 테이블의 스키마를 위해 한 번, 행을 위해 한 번 쿼리를 두 번 계획하므로, 변경되는
선택자는 매번 다른 버전을 선택할 수 있습니다. 하나의 버전을 정확히 복사하려면 `version`을 설정하세요.
- `EXPLAIN`은 선택한 버전을 `lanceVersion`, 브랜치를 `lanceBranch`, REST Namespace의 버전 관리
여부를 `lanceManagedVersioning`으로 표시합니다. `EXPLAIN`도 스냅샷을 다시 선택하므로, 실제 실행에서 읽은 정보는
쿼리 Profile에 기록됩니다. `LanceDatasetVersion`과 `LanceDatasetUri`가 `LanceSearchType`
등 Lance Scanner의 다른 정보와 함께 표시됩니다. URI에는 브랜치 디렉터리가 포함되고 쿼리 문자열과 비밀번호는 제외됩니다.
diff --git
a/i18n/ko/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
b/i18n/ko/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
index c5995f22ebf..2d0f7b7b0e3 100644
---
a/i18n/ko/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
+++
b/i18n/ko/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
@@ -70,3 +70,4 @@ ANALYZE TABLE lineitem WITH SAMPLE PERCENT 10;
```sql
ANALYZE TABLE lineitem WITH SAMPLE ROWS 100000;
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
index d39369d5652..3c679e6e9df 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md
@@ -52,7 +52,6 @@ PR 提交流程还可以参考：
```plain
.
├── blog
-│ ├── 1.1 Release.md
│ ├── Annoucing.md
│ ├── jd.md
│ ├── meituan.md
@@ -66,37 +65,36 @@ PR 提交流程还可以参考：
│ ├── ......
├── docs
│ ├── admin-manual
+│ │ ├── auth
│ │ ├── cluster-management
│ │ ├── config
│ │ ├── data-admin
-│ │ ├── http-actions
+│ │ ├── log-management
│ │ ├── maint-monitor
-│ │ ├── privilege-ldap
-│ │ ├── multi-tenant.md
-│ │ ├── optimization.md
-│ │ ├── query-profile.md
-│ │ └── sql-interception.md
-│ │ └── workload-group.md
+│ │ ├── open-api
+│ │ ├── system-tables
+│ │ ├── trouble-shooting
+│ │ ├── workload-management
+│ │ └── audit-plugin.md
│ ├── ......
├── i18n
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
│ │ ├── current
-│ │ ├── version-1.2
-│ │ ├── version-2.0
│ │ ├── version-2.1
+│ │ ├── version-3.x
+│ │ ├── version-4.x
│ │ ├── current.json
-│ │ ├── version-1.2.json
-│ │ ├── version-2.0.json
│ │ ├── version-2.1.json
-│ ├── docusaurus-plugin-content-docs-community
-│ └── local_build_docs.sh
+│ │ ├── version-3.x.json
+│ │ └── version-4.x.json
+│ └── docusaurus-plugin-content-docs-community
├── src
│ ├── components
│ │ ├── Icons
│ │ ├── More
-│ │ ├── PageBanner
-│ │ └── PageColumn
+│ │ ├── PageColumn
+│ │ └── PageHeader
│ ├── ......
├── static
│ ├── images
@@ -105,20 +103,19 @@ PR 提交流程还可以参考：
│ └── js
│ └── redirect.js
├── versioned_docs
-│ ├── version-1.2
-│ ├── version-2.0
-│ └── version-2.1
+│ ├── version-2.1
+│ ├── version-3.x
+│ └── version-4.x
├── versioned_sidebars
-│ ├── version-1.2-sidebars.json
-│ ├── version-2.0-sidebars.json
-│ └── version-2.1-sidebars.json
-├── babel.config.js
+│ ├── version-2.1-sidebars.json
+│ ├── version-3.x-sidebars.json
+│ └── version-4.x-sidebars.json
├── build.sh
-├── buildVersions.sh
├── docusaurus.config.js
+├── local_build_docs.sh
├── package.json
├── README.md
-├── sidebars.json
+├── sidebars.ts
├── sidebarsCommunity.json
├── tsconfig.json
└── versions.json
@@ -131,13 +128,14 @@ PR 提交流程还可以参考：
| `blog/` | 博客文章 Markdown | 所有版本共用 |
| `community/` | 英文社区文档 | 所有版本共用 |
| `docs/` | 英文最新版（Dev / Master）文档 | 当前主干 |
-| `versioned_docs/version-X.X/` | 英文历史版本文档 | 1.2 / 2.0 / 2.1 等 |
+| `versioned_docs/version-X.X/` | 英文已发布版本文档 | 4.x / 3.x / 2.1（见
`versions.json`） |
| `i18n/zh-CN/docusaurus-plugin-content-docs/current/` | 中文最新版文档 | 当前主干 |
-| `i18n/zh-CN/docusaurus-plugin-content-docs/version-X.X/` | 中文历史版本文档 | 1.2 /
2.0 / 2.1 等 |
+| `i18n/zh-CN/docusaurus-plugin-content-docs/version-X.X/` | 中文已发布版本文档 | 4.x /
3.x / 2.1（见 `versions.json`） |
| `i18n/zh-CN/docusaurus-plugin-content-docs-community/` | 中文社区文档 | 所有版本共用 |
-| `sidebars.json` | 最新版文档侧边栏 | 中英文共用 |
-| `versioned_sidebars/version-X.X-sidebars.json` | 历史版本文档侧边栏 | 中英文共用 |
+| `sidebars.ts` | 最新版文档侧边栏 | 中英文共用 |
+| `versioned_sidebars/version-X.X-sidebars.json` | 已发布版本文档侧边栏 | 中英文共用 |
| `sidebarsCommunity.json` | 社区文档侧边栏 | 所有版本共用 |
+| `versions.json` | 网站发布的已发布版本列表 | 所有已发布版本 |
| `static/images/` | 文档图片资源 | 所有版本共用 |
## 博客目录
@@ -152,7 +150,7 @@ PR 提交流程还可以参考：
修改文档时，根据修改类型需要同时改动不同文件：
-1. **修改已有文档内容**：需要同时更新 Master 分支最新文档版本以及相应的各版本（如 2.1、2.0、1.2 或多版本）。
+1. **修改已有文档内容**：需要同时更新 Master 分支最新文档版本以及相应的已发布版本（如 4.x、3.x、2.1 或其中多个版本）。
2. **新增文档**：除了上传新的 Markdown 文件，还需要在 Sidebar 文件中添加新文档链接路径。
3. **新增文档目录栏**：除了调整目录结构，还需要对新增的目录栏补充中文翻译。
@@ -161,8 +159,8 @@ PR 提交流程还可以参考：
| 文件类型 | 作用 | 示例 |
| --- | --- | --- |
| Markdown 文件 | 文档正文内容 | `docs/admin-manual/xxx.md` |
-| Sidebar 文件 | 控制目录结构 | `sidebars.json` / `version-2.1-sidebars.json` |
-| 翻译文件 | 控制目录栏在中文文档中的显示 | `current.json` / `version-2.1.json` |
+| Sidebar 文件 | 控制目录结构 | `sidebars.ts` / `version-4.x-sidebars.json` |
+| 翻译文件 | 控制目录栏在中文文档中的显示 | `current.json` / `version-4.x.json` |
:::caution 注意
@@ -192,38 +190,36 @@ PR 提交流程还可以参考：
**2. 文档目录结构**
-Dev 版本中英文文档统一由根目录下 `sidebars.json` 控制。
-
-`sidebars.json` 示例：
-
-```json
-{
- "docs": [
- {
- "type": "category",
- "label": "Getting Started",
- "items": [
- "get-starting/quick-start",
- "get-starting/what-is-apache-doris"
- ]
- },
- {
- "type": "category",
- "label": "Install and Deploy",
- "items": [
- "install/standard-deployment",
- {
- "type": "category",
- "label": "Docker Deployment",
- "items": [
- "install/construct-docker/build-docker-image",
- "install/construct-docker/run-docker-cluster"
- ]
- }
- ......
- }
- ]
- }
+Dev 版本中英文文档统一由根目录下 `sidebars.ts` 控制。
+
+`sidebars.ts` 示例：
+
+```ts
+const sidebars: SidebarsConfig = {
+ docs: [
+ {
+ type: 'category',
+ label: 'Get Started',
+ collapsible: false,
+ collapsed: false,
+ items: [
+ {
+ type: 'category',
+ label: 'Getting Started',
+ link: {type: 'doc', id: 'getting-started/intro'},
+ collapsed: true,
+ items: [
+ 'getting-started/what-is-apache-doris',
+ 'getting-started/quick-start',
+ 'getting-started/before-you-start-the-poc',
+ ],
+ },
+ ......
+ ],
+ },
+ ......
+ ],
+};
```
**3. 目录栏中文翻译**
@@ -232,8 +228,8 @@ Dev 版本的目录栏中文翻译文件位于 `i18n/zh-CN/docusaurus-plugin-con
以目录栏「快速开始」为例：
-- `sidebar.docs.category.Getting Started` 与 `sidebars.json` 中的 `label` 层级对应
-- 编写格式为：`sidebar` + `.` + `docs` + `.` + `[type]` + `[label]`
+- `sidebar.docs.category.Getting Started` 与 `sidebars.ts` 中的 `label` 层级对应
+- 编写格式为：`sidebar` + `.` + `docs` + `.` + `[type]` + `.` + `[label]`
```json
{
@@ -249,34 +245,33 @@ Dev 版本的目录栏中文翻译文件位于 `i18n/zh-CN/docusaurus-plugin-con
}
```
-对应的 `sidebars.json` 片段：
+对应的 `sidebars.ts` 片段：
-```json
+```ts
{
- "docs": [
- {
- "type": "category",
- "label": "Getting Started",
- "items": [
- "get-starting/quick-start",
- "get-starting/what-is-apache-doris"
- ]
- },
- ......
- }
- ]
- }
+ type: 'category',
+ label: 'Getting Started',
+ link: {type: 'doc', id: 'getting-started/intro'},
+ collapsed: true,
+ items: [
+ 'getting-started/what-is-apache-doris',
+ 'getting-started/quick-start',
+ 'getting-started/before-you-start-the-poc',
+ ],
+},
```
-### 2.1 / 2.0 / 1.2 历史版本
+### 4.x / 3.x / 2.1 已发布版本
**1. 内容修改位置**
+网站发布的已发布版本列在根目录的 `versions.json` 中，目前为 4.x、3.x 和 2.1。仓库中仍保留 `version-1.2` 和
`version-2.0` 目录，但它们不在 `versions.json` 中，也不会构建到网站。
+
| 版本 | 英文文档位置 | 中文文档位置 |
| --- | --- | --- |
+| 4.x | `/versioned_docs/version-4.x` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x` |
+| 3.x | `/versioned_docs/version-3.x` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x` |
| 2.1 | `/versioned_docs/version-2.1` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1` |
-| 2.0 | `/versioned_docs/version-2.0` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0` |
-| 1.2 | `/versioned_docs/version-1.2` |
`i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2` |
```plain
.
@@ -287,13 +282,13 @@ Dev 版本的目录栏中文翻译文件位于 `i18n/zh-CN/docusaurus-plugin-con
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
│ │ ├── current
-│ │ ├── version-1.2
-│ │ ├── version-2.0
│ │ ├── version-2.1
+│ │ ├── version-3.x
+│ │ ├── version-4.x
├── versioned_docs
-│ ├── version-1.2
-│ ├── version-2.0
│ ├── version-2.1
+│ ├── version-3.x
+│ ├── version-4.x
```
**2. 文档目录结构**
@@ -303,12 +298,12 @@ Dev 版本的目录栏中文翻译文件位于 `i18n/zh-CN/docusaurus-plugin-con
```plain
.
├── versioned_sidebars
-│ ├── version-1.2-sidebars.json
-│ ├── version-2.0-sidebars.json
-│ └── version-2.1-sidebars.json
+│ ├── version-2.1-sidebars.json
+│ ├── version-3.x-sidebars.json
+│ └── version-4.x-sidebars.json
```
-各版本 Sidebar 层级修改与 Dev 版本基本一致，此处不再举例。
+各版本的 Sidebar 文件为 JSON 格式，结构与 `sidebars.ts` 相同。各版本 Sidebar 层级修改与 Dev
版本基本一致，此处不再举例。
**3. 目录栏中文翻译**
@@ -318,9 +313,9 @@ Dev 版本的目录栏中文翻译文件位于 `i18n/zh-CN/docusaurus-plugin-con
├── i18n
│ └── zh-CN
│ ├── docusaurus-plugin-content-docs
-│ │ ├── version-1.2.json
-│ │ ├── version-2.0.json
│ │ ├── version-2.1.json
+│ │ ├── version-3.x.json
+│ │ ├── version-4.x.json
```
各版本中文文档 `label` 翻译与 Dev 版本基本一致，此处不再举例。
@@ -341,24 +336,24 @@ Dev 版本的目录栏中文翻译文件位于 `i18n/zh-CN/docusaurus-plugin-con
```json
{
"version.label": {
- "message": "Next",
+ "message": "current",
"description": "The label for version current"
},
"sidebar.community.category.How to Contribute": {
- "message": "贡献指南",
+ "message": "参与贡献",
"description": "The label for category How to Contribute in sidebar
community"
},
- "sidebar.community.category.Release Process & Verification": {
- "message": "版本发布与校验",
- "description": "The label for category Release Process & Verification
in sidebar community"
+ "sidebar.community.category.Documentation Contribution": {
+ "message": "贡献文档",
+ "description": "The label for category Documentation Contribution in
sidebar community"
+ },
+ "sidebar.community.category.Release": {
+ "message": "版本与发布",
+ "description": "The label for category Release in sidebar community"
},
"sidebar.community.category.Design Documents": {
"message": "设计文档",
"description": "The label for category Design Documents in sidebar
community"
- },
- "sidebar.community.category.Developer Guide": {
- "message": "开发者手册",
- "description": "The label for category Developer Guide in sidebar
community"
}
}
```
diff --git
a/translations/state/ko/pages/community/current/how-to-contribute/contribute-doc.json
b/translations/state/ko/pages/community/current/how-to-contribute/contribute-doc.json
index 2d8b3db92fa..00ad0d74af8 100644
---
a/translations/state/ko/pages/community/current/how-to-contribute/contribute-doc.json
+++
b/translations/state/ko/pages/community/current/how-to-contribute/contribute-doc.json
@@ -8,13 +8,13 @@
"sourceLocale": "en",
"sourcePath": "community/how-to-contribute/contribute-doc.md",
"targetPath":
"i18n/ko/docusaurus-plugin-content-docs-community/current/how-to-contribute/contribute-doc.md",
- "sourceCommit": "f1464d3fb0dd6007d36104a970c3bc7db282d822",
- "sourceHash":
"92adddc806e422b80b5be3a9f2c075d436e64edfe50b6241939addb25f2b77c0",
- "sourceTechnicalHash":
"5307a5f274e0ecb35c2e1aa50b86d12a518436bc7cf8564a2a02e1f11d080ac8",
- "targetHash":
"4f686a98badc3d1fc7379242064d4ff4941539148ceebb68f50592c2345b936a",
+ "sourceCommit": "d45c715cc32da861e31939e1fcfab61834edf693",
+ "sourceHash":
"65d2d46b954648611c80316916487b7879046b25e6a092ded691cb7e811fbf4c",
+ "sourceTechnicalHash":
"89f650720d3566eec6ecd7ef612306f5f6c273b3119e6cf40c37ad77cf07f689",
+ "targetHash":
"ec9e8a1bc75fc26f71358a9e777359a436690a11be7f2874f263e55b507dfc13",
"reviewStatus": "machine",
"ownership": "machine",
- "translatedAt": "2026-10-19T15:40:50.341Z",
+ "translatedAt": "2026-10-19T17:58:57.510Z",
"glossaryVersion": "1",
"generation": {
"policy": "whole-document-v1",
diff --git
a/translations/state/ko/pages/default/4.x/lakehouse/catalogs/lance-catalog.json
b/translations/state/ko/pages/default/4.x/lakehouse/catalogs/lance-catalog.json
index c3aeeb3b371..336675df537 100644
---
a/translations/state/ko/pages/default/4.x/lakehouse/catalogs/lance-catalog.json
+++
b/translations/state/ko/pages/default/4.x/lakehouse/catalogs/lance-catalog.json
@@ -11,10 +11,10 @@
"sourceCommit": "f1464d3fb0dd6007d36104a970c3bc7db282d822",
"sourceHash":
"0170b6ca44943ddfd32b4628593ec69788791b2ed276a429b258ed80f5a22fdc",
"sourceTechnicalHash":
"a0e66ca41781b29c952cf6e852de18e4afbbcad01a9b020853fcad516ce96658",
- "targetHash":
"7a0872c95fa73cbdd40a80f56b8c83d76161450998c7a7986e35f838472a7993",
+ "targetHash":
"a1b29ef8e224ab84b3739f1402b239073d82713cf28043cc3c3b0021ff433a4d",
"reviewStatus": "machine",
"ownership": "machine",
- "translatedAt": "2026-10-19T10:45:13.528Z",
+ "translatedAt": "2026-10-19T17:58:58.828Z",
"glossaryVersion": "1",
"generation": {
"policy": "whole-document-v1",
diff --git
a/translations/state/ko/pages/default/4.x/sql-manual/sql-statements/statistics/ANALYZE.json
b/translations/state/ko/pages/default/4.x/sql-manual/sql-statements/statistics/ANALYZE.json
index aa015af7eed..1d2dcc3a100 100644
---
a/translations/state/ko/pages/default/4.x/sql-manual/sql-statements/statistics/ANALYZE.json
+++
b/translations/state/ko/pages/default/4.x/sql-manual/sql-statements/statistics/ANALYZE.json
@@ -8,13 +8,13 @@
"sourceLocale": "en",
"sourcePath":
"versioned_docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md",
"targetPath":
"i18n/ko/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md",
- "sourceCommit": "f1464d3fb0dd6007d36104a970c3bc7db282d822",
- "sourceHash":
"7fff46f665bc5c1bfa9968a5cf8f0d5533f84b60149324aa47683796f8bfad71",
- "sourceTechnicalHash":
"01577e3e555e96d4d2972afe2d1172bcb187f66aa87a4bee7e30de25084df2f0",
- "targetHash":
"e7e5d826a6122e1a65f9156cb7acb7f945999109c833848bbd4dc929532e5e3e",
+ "sourceCommit": "d45c715cc32da861e31939e1fcfab61834edf693",
+ "sourceHash":
"b742be3d1417bf6ddd95228d9eced76229e8ea0dc021e0b19068c4a934d9b4b7",
+ "sourceTechnicalHash":
"4f7f7552d70446f083962a4e53755b6c04f3c683851a7f2754b9b8a0f68cf661",
+ "targetHash":
"dd83c9d9f8df003a851dac36429f2814e70067de21e55ca3327d10617aab896b",
"reviewStatus": "machine",
"ownership": "machine",
- "translatedAt": "2026-10-19T15:00:12.210Z",
+ "translatedAt": "2026-10-19T17:58:58.960Z",
"glossaryVersion": "1",
"generation": {
"policy": "whole-document-v1",
diff --git
a/translations/state/ko/pages/default/current/admin-manual/maint-monitor/automatic-service-start.json
b/translations/state/ko/pages/default/current/admin-manual/maint-monitor/automatic-service-start.json
index 316ed23cdad..1c7d5c7a411 100644
---
a/translations/state/ko/pages/default/current/admin-manual/maint-monitor/automatic-service-start.json
+++
b/translations/state/ko/pages/default/current/admin-manual/maint-monitor/automatic-service-start.json
@@ -11,10 +11,10 @@
"sourceCommit": "84f382d820669d8811a29dd2ae820d45c596e987",
"sourceHash":
"6fc335287cad909f2b65a7b0b4e1792ef06df9d5507975af1c39198c6eefea36",
"sourceTechnicalHash":
"2906eadd40f23be6f8bf3b76969fe60fe9a85ab0dd8bde10909b3b510690782d",
- "targetHash":
"1b042c42f1e8b27478e805034a04720a140d58895fe06769daaf23f262990c3c",
+ "targetHash":
"7c86023c73bd7b5cb3e5ab442662709396118be19784c7d2f1ea0ca4306a7d91",
"reviewStatus": "machine",
"ownership": "machine",
- "translatedAt": "2026-10-18T22:20:25.246Z",
+ "translatedAt": "2026-10-19T17:58:57.780Z",
"glossaryVersion": "1",
"generation": {
"policy": "whole-document-v1",
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/statistics/ANALYZE.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/statistics/ANALYZE.md
index 47f21cffb8c..65c42f1f280 100644
--- a/versioned_docs/version-2.1/sql-manual/sql-statements/statistics/ANALYZE.md
+++ b/versioned_docs/version-2.1/sql-manual/sql-statements/statistics/ANALYZE.md
@@ -70,4 +70,4 @@ ANALYZE TABLE lineitem WITH SAMPLE PERCENT 10;
```sql
ANALYZE TABLE lineitem WITH SAMPLE ROWS 100000;
-
+```
diff --git
a/versioned_docs/version-3.x/sql-manual/sql-statements/statistics/ANALYZE.md
b/versioned_docs/version-3.x/sql-manual/sql-statements/statistics/ANALYZE.md
index 47f21cffb8c..65c42f1f280 100644
--- a/versioned_docs/version-3.x/sql-manual/sql-statements/statistics/ANALYZE.md
+++ b/versioned_docs/version-3.x/sql-manual/sql-statements/statistics/ANALYZE.md
@@ -70,4 +70,4 @@ ANALYZE TABLE lineitem WITH SAMPLE PERCENT 10;
```sql
ANALYZE TABLE lineitem WITH SAMPLE ROWS 100000;
-
+```
diff --git
a/versioned_docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
b/versioned_docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
index 47f21cffb8c..65c42f1f280 100644
--- a/versioned_docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
+++ b/versioned_docs/version-4.x/sql-manual/sql-statements/statistics/ANALYZE.md
@@ -70,4 +70,4 @@ ANALYZE TABLE lineitem WITH SAMPLE PERCENT 10;
```sql
ANALYZE TABLE lineitem WITH SAMPLE ROWS 100000;
-
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
