Google Git
Sign in
apache/doris-website/refs/heads/master
commit
bd6c9955fd09e9dccac4d2494ed0efdce6080106
[log]
author
Mingyu Chen (Rayner) <morningman@163.com>
Tue Apr 28 10:37:11 2026 -0700
committer
GitHub <noreply@github.com>
Tue Apr 28 10:37:11 2026 -0700
tree
4ee05f39047d47ae5335058a23e5c76fd910f533
parent
fc76b975ff94776f5d448068765216eac35c1b8a [diff]
[fix] fix image in behind-index.md (#3595)

## Versions 

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

## Languages

- [x] Chinese
- [x] English
- [ ] Japanese candidate translation needed

## Docs Checklist

- [ ] Checked by AI
- [ ] Test Cases Built
- [ ] Updated required version and language counterparts, or explained
why not
- [ ] If only one language changed, confirmed whether source/translation
counterparts need sync
11 files changed
tree: 4ee05f39047d47ae5335058a23e5c76fd910f533
  1. .docs-governance/
  2. .github/
  3. .vscode/
  4. blog/
  5. community/
  6. config/
  7. developer_docs/
  8. docs/
  9. docs-next/
  10. i18n/
  11. ja-build/
  12. ja-source/
  13. releasenotes/
  14. scripts/
  15. shared/
  16. src/
  17. static/
  18. templates/
  19. tools/
  20. userCases/
  21. versioned_docs/
  22. versioned_sidebars/
  23. website-quality-governance/
  24. .asf-site.yaml
  25. .asf.yaml
  26. .dlc.json
  27. .gitignore
  28. .gitmodules
  29. .markdownlint.json
  30. .prettierrc.js
  31. AGENTS.md
  32. author.yml
  33. auto_correct_format.py
  34. build-docs.sh
  35. build.sh
  36. buildVersions.json
  37. check_all_deadlink.py
  38. check_docs_version_diff.py
  39. check_move.py
  40. check_move_global.py
  41. crowdin.yml
  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. next_versions.json
  50. package.json
  51. README.md
  52. sidebars-next.ts
  53. sidebars.ts
  54. sidebarsCommunity.json
  55. sidebarsReleases.json
  56. store_format_v3.md
  57. tailwind.config.js
  58. TOC.md
  59. tsconfig.json
  60. versions.json
  61. 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.ymlDaily at 01:00 AMSyncs from Doris master branch and deploys
manual-deploy-website.ymlManualDeploy from a specified branch
build-check.ymlOn PRValidates the build passes (incrementally by detected version)