Google Git Google Git
Sign in
apache/doris-website/refs/heads/master
commit
87417f1fefb604bf8a98d1fea0ace4beaccc4b2c
[log]
author
wudi <wudi@selectdb.com>
Thu Oct 22 17:43:45 2026 +0800
committer
GitHub <noreply@github.com>
Thu Oct 22 17:43:45 2026 +0800
tree
69a8bbb48ab7a32a54e933b9d5de6d47d402308b
parent
8f714fef54cbb3e1887308cedcfca6982493c347 [diff] 
[doc](flink) Document recovery from persisted consumption offsets (#4438)

Update the English and Chinese dev docs for automatic recovery from the
persisted offset table. Describe recovery precedence, checkpoint-covered
asynchronous writes, consumer ID isolation, and how to start a fresh
snapshot after changelog expiration.

This feature requires Doris 5.0, so the older versioned pages are
unchanged.

Pin the Build Check runner to Ubuntu 22.04 so its existing Python 3.9
setup remains installable after ubuntu-latest moved to Ubuntu 26.04.

## Validation

- Docusaurus compilation of both updated pages passed.
- Internal link checks and git diff whitespace checks passed.
- English and Chinese SQL/output blocks match; front matter and heading
anchors are preserved.
- 52 related workflow tests passed; YAML comparison confirms only the
runner image changed.
- Full site build and live integration tests were not run locally.

## Versions

- [x] dev
- [ ] 4.x
- [ ] 3.x
- [ ] 2.1 or older (not covered by version/language sync gate)

## Languages

- [x] Chinese
- [x] English

## Docs Checklist

- [x] Checked by AI
- [ ] Test Cases Built
- [x] Updated required version and language counterparts, or explained
why not
- [x] If only one language changed, confirmed whether source/translation
counterparts need sync
3 files changed
tree: 69a8bbb48ab7a32a54e933b9d5de6d47d402308b
  1. .docs-governance/
  2. .github/
  3. .vscode/
  4. blog/
  5. community/
  6. config/
  7. course/
  8. deprecated-docs/
  9. developer_docs/
  10. doc-tools/
  11. docs/
  12. i18n/
  13. plan-doc/
  14. releasenotes/
  15. scripts/
  16. shared/
  17. src/
  18. static/
  19. templates/
  20. translations/
  21. userCases/
  22. versioned_docs/
  23. versioned_sidebars/
  24. website-quality-governance/
  25. .asf-site.yaml
  26. .asf.yaml
  27. .dlc.json
  28. .gitignore
  29. .gitmodules
  30. .markdownlint.json
  31. .prettierrc.js
  32. AGENTS.md
  33. author.yml
  34. auto_correct_format.py
  35. build-docs.sh
  36. build.sh
  37. buildVersions.json
  38. check_all_deadlink.py
  39. check_docs_version_diff.py
  40. check_move.py
  41. check_move_global.py
  42. cspell.json
  43. docusaurus.config.js
  44. LICENSE
  45. local_build_docs.sh
  46. local_dev.sh
  47. local_dev_next.sh
  48. modify-deadlink.py
  49. package.json
  50. README.md
  51. sidebars.ts
  52. sidebarsCommunity.json
  53. sidebarsCourse.ts
  54. sidebarsReleases.json
  55. store_format_v3.md
  56. tailwind.config.js
  57. TOC.md
  58. tsconfig.json
  59. versions.json
  60. yarn.lock
README.md

Apache Doris Website

Source code for doris.apache.org, built with Docusaurus 3.

Quick Start

Prerequisites

  • Node.js >= 18
  • Yarn

Local Development

Use local_dev.sh to run the site locally. It handles dependency installation, version filtering, and memory settings automatically.

# Start English dev server (default: only 'current' version, 2 GB memory)
./local_dev.sh

# Start Chinese dev server
./local_dev.sh start-zh

# Start on a custom port
./local_dev.sh start --port 8080

# Build a specific doc version
./local_dev.sh start --versions "4.x"

# Build English docs (production build)
./local_dev.sh build

# Build all locales (en + zh-CN)
./local_dev.sh build-all

# Clean build artifacts and caches
./local_dev.sh clean

Run ./local_dev.sh help for all available commands and options.

Production Build

export NODE_OPTIONS=--max-old-space-size=8192
yarn install
yarn docusaurus build --locale en --locale zh-CN

The output is generated in the build/ directory.

Directory Structure

.
├── docs/                         # Current (dev) version docs (English)
├── versioned_docs/
│   ├── version-4.x/              # 4.x version docs (English)
│   ├── version-3.x/              # 3.x version docs (English)
│   └── version-2.1/              # 2.1 version docs (English)
├── i18n/zh-CN/
│   └── docusaurus-plugin-content-docs/
│       ├── current/              # Current (dev) version docs (Chinese)
│       ├── version-4.x/          # 4.x version docs (Chinese)
│       ├── version-3.x/          # 3.x version docs (Chinese)
│       └── version-2.1/          # 2.1 version docs (Chinese)
├── blog/                         # Blog posts
├── community/                    # Community docs
├── src/                          # React components and pages
├── static/                       # Static assets (images, JS, CSS)
├── sidebars.ts                   # Sidebar for current (dev) docs
├── versioned_sidebars/           # Sidebar files per version
│   ├── version-4.x-sidebars.json
│   ├── version-3.x-sidebars.json
│   └── version-2.1-sidebars.json
├── sidebarsCommunity.json        # Sidebar for community docs
├── versions.json                 # Active doc versions
├── docusaurus.config.js          # Docusaurus configuration
└── local_dev.sh                  # Local development helper script

Contributing Documentation

For general contribution guidelines, see:

Editing Docs

When modifying docs, you typically need to update both the English and Chinese versions in the corresponding directories:

VersionEnglishChineseSidebar
Current (dev)docs/i18n/zh-CN/.../current/sidebars.ts
4.xversioned_docs/version-4.x/i18n/zh-CN/.../version-4.x/versioned_sidebars/version-4.x-sidebars.json
3.xversioned_docs/version-3.x/i18n/zh-CN/.../version-3.x/versioned_sidebars/version-3.x-sidebars.json
2.1versioned_docs/version-2.1/i18n/zh-CN/.../version-2.1/versioned_sidebars/version-2.1-sidebars.json

Note: When adding a new page, you must also add its path to the corresponding sidebar file, otherwise it will not appear in the navigation.

Editing Blog Posts

Blog posts are located in the blog/ directory. Submit a PR to add or modify blog content.

Editing Community Docs

Community docs are in community/, with navigation controlled by sidebarsCommunity.json. Chinese community content lives under i18n/zh-CN/docusaurus-plugin-content-docs-community/.

Images

All images are stored in static/images/. Use hyphens to separate words in filenames (e.g., query-profile-example.png).

![Description of the image](/images/my-screenshot.png)

CI / Deployment

The site is deployed via GitHub Actions:

WorkflowTriggerDescription
cron-deploy-website.ymlPush to master; daily at 01:00 UTCBuilds and deploys the site; the daily run refreshes dynamic data and provides a fallback
manual-deploy-website.ymlManualDeploy from a specified branch
build-check.ymlOn PRValidates the build passes (incrementally by detected version)