Об этом проекте

Этот репозиторий содержит исходный код официального сайта Apache Doris, размещаемого по адресу doris.apache.org. Он создан с помощью Docusaurus 3 — современного генератора статических сайтов. ## Что содержит - **Документация**: англоязычная и китайская (zh-CN) документация по нескольким версиям (current/dev, 4.x, 3.x, 2.1) - **Блог**: новости и объявления проекта - **Сообщество**: руководства по участию и ресурсы сообщества - **React-компоненты**: пользовательские страницы и элементы UI в директории `src/` ## Технологический стек - Docusaurus 3 (генератор статических сайтов) - Node.js >= 18 - Менеджер пакетов Yarn - React-компоненты ## Локальная разработка Вспомогательный скрипт (`local_dev.sh`) упрощает запуск сайта локально: ```bash # Запуск английского dev-сервера ./local_dev.sh # Запуск китайского dev-сервера ./local_dev.sh start-zh # Пользовательский порт ./local_dev.sh start --port 8080 # Сборка продакшен-версии (английская + китайская) ./local_dev.sh build-all ``` Для крупных сборок можно увеличить объём памяти через `NODE_OPTIONS=--max-old-space-size=8192`. ## Версионирование Документация версионируется: отдельные директории для каждой версии находятся в `docs/` (текущая) и `versioned_docs/` (архивные версии). Боковые панели (sidebars) управляются отдельно для каждой версии в `sidebars.ts` и `versioned_sidebars/`. ## Многоязычная поддержка Сайт поддерживает английский и упрощённый китайский языки. Китайские переводы находятся в `i18n/zh-CN/`. При редактировании обычно требуется обновить обе языковые версии. ## Структура директорий - `docs/` — текущая английская документация - `versioned_docs/` — архивная английская документация по версиям - `i18n/zh-CN/` — китайские переводы, соответствующие вышеуказанной структуре - `blog/` — публикации в блоге в формате Markdown - `community/` — документация сообщества - `src/` — React-компоненты и пользовательские страницы - `static/` — статические ресурсы (изображения, CSS, JS) ## CI / Развёртывание GitHub Actions выполняет автоматические сборки: - Ежедневное развёртывание по cron из ветки master Doris - Ручной workflow развёртывания для отдельных веток - Проверка сборки при pull request'ах ## Вклад в проект Руководства по участию доступны на сайте Doris; они охватывают спецификации формата документации и общие процессы внесения вклада.