doris-website

This repository contains the source code for the Apache Doris official website, hosted at doris.apache.org. It is built using Docusaurus 3, a modern static site generator. ## What It Contains - **Documentation**: English and Chinese (zh-CN) docs across multiple versions (current/dev, 4.x, 3.x, 2.1) - **Blog**: Project news and announcements - **Community**: Contribution guidelines and community resources - **React Components**: Custom pages and UI elements in the `src/` directory ## Technology Stack - Docusaurus 3 (static site generator) - Node.js >= 18 - Yarn package manager - React-based components ## Local Development A helper script (`local_dev.sh`) simplifies running the site locally: ```bash # Start English dev server ./local_dev.sh # Start Chinese dev server ./local_dev.sh start-zh # Custom port ./local_dev.sh start --port 8080 # Production build (English + Chinese) ./local_dev.sh build-all ``` Memory can be increased via `NODE_OPTIONS=--max-old-space-size=8192` for large builds. ## Versioning Docs are versioned with separate directories for each release line under `docs/` (current) and `versioned_docs/` (archived versions). Sidebars are managed separately per version in `sidebars.ts` and `versioned_sidebars/`. ## Multilingual Support The site supports English and Simplified Chinese. Chinese translations live under `i18n/zh-CN/`. When editing, both language versions typically need updates. ## Directory Structure - `docs/` — current English docs - `versioned_docs/` — archived English docs by version - `i18n/zh-CN/` — Chinese translations matching the above structure - `blog/` — Markdown blog posts - `community/` — community documentation - `src/` — React components and custom pages - `static/` — static assets (images, CSS, JS) ## CI / Deployment GitHub Actions handle automated builds: - Daily cron deployment syncing from the Doris master branch - Manual deploy workflow for specific branches - Build validation on pull requests ## Contributing Contribution guidelines are available on the Doris website, covering documentation format specifications and general contribution processes.