Google Git
Sign in
apache/doris-website/refs/heads/master
commit
d17e2de79a3bd8e3a08abc889101625d59f6efb7
[log]
author
Mingyu Chen (Rayner) <morningman@163.com>
Thu Aug 20 21:54:14 2026 +0800
committer
GitHub <noreply@github.com>
Thu Aug 20 21:54:14 2026 +0800
tree
b5a736a001a41ddcb4d69a6251508140812a61e3
parent
672c14ee27f90caf8fc30e64f6bc93a8a3f7dfdf [diff]
[doc](community) add the all-in-one image guide for integration testing (#4078)

## Summary

Adds a developer guide for the official `apache/doris:all-in-one-*`
image, under **Development & Debugging > Testing**.

The doc serves two purposes:

1. **For downstream / ecosystem projects** (connectors, SDKs, data
integration tools) that need a real Doris instance in their e2e / CI
runs rather than a mock: what the image provides as a test fixture, how
the `base` and `-full` tags differ, multi-architecture support, and
ready-to-copy usage with `docker run`, Docker Compose
(`service_healthy`) and GitHub Actions service containers, plus
configuration knobs, persistence and troubleshooting.
2. **For anyone building the image themselves**: a short section with
the three commands that cover the common cases, linking to the
[README](https://github.com/apache/doris/blob/master/docker/runtime/all-in-one/4.1/README.md)
in the Doris repository for everything else.

The build section is deliberately kept brief and the version number is
used only as an example, so a new Doris release does not require
maintaining this page.

Source of truth for the content: `docker/runtime/all-in-one/4.1/` in
apache/doris (added in apache/doris#66983).

## Changes

- `community/developer-guide/all-in-one-image.md` (EN)
-
`i18n/zh-CN/docusaurus-plugin-content-docs-community/current/developer-guide/all-in-one-image.md`
(ZH)
- `sidebarsCommunity.json`: new entry under **Testing**, after
`developer-guide/regression-testing`

## Verification

- `yarn docusaurus build` succeeds; both pages are generated for `en`
and `zh-CN`
- `yarn docs:links:changed`, `yarn docs:seo:changed`, `yarn
docs:i18n-sync:changed` and the frontmatter / markdown-structure lints
report no findings for the new files
- EN and ZH pages have identical heading structure, tables and code
blocks
- Ports, environment variables, config keys, mount paths and log paths
were checked against the Dockerfile, entrypoint.sh and conf files of the
image; the `all-in-one-4.1.3` and `-full` tags were confirmed to be
published as multi-arch (amd64 + arm64) on Docker Hub

---------

Co-authored-by: morningman <moringman@apache.org>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
3 files changed
tree: b5a736a001a41ddcb4d69a6251508140812a61e3
  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. 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. cspell.json
  42. docusaurus.config.js
  43. LICENSE
  44. local_build_docs.sh
  45. local_dev.sh
  46. local_dev_next.sh
  47. modify-deadlink.py
  48. package.json
  49. README.md
  50. sidebars.ts
  51. sidebarsCommunity.json
  52. sidebarsCourse.ts
  53. sidebarsReleases.json
  54. store_format_v3.md
  55. tailwind.config.js
  56. TOC.md
  57. tsconfig.json
  58. versions.json
  59. 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)