Revert "ci: deploy website (apache#119)"

This reverts commit 81561e6.

.asf.yaml

@@ -18,8 +18,9 @@
 # For more information, see https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features.
 
 github:
-  description: HoraeDB Website.
-  homepage: https://horaedb.apache.org/
+  description: >-
+    HoraeDB Website.
+  homepage: https://apache.github.io/incubator-horaedb-docs # TODO: after website is ready, set to https://horaedb.apache.org/
   labels:
     - rust
     - sql
@@ -40,14 +41,10 @@ github:
       required_pull_request_reviews:
         dismiss_stale_reviews: true
         required_approving_review_count: 1
-    asf-site: {}
-
-publish:
-  whoami: asf-site
 
 notifications:
   commits:      commits@horaedb.apache.org
   issues:       commits@horaedb.apache.org
   pullrequests: commits@horaedb.apache.org
   jobs:         commits@horaedb.apache.org
-  discussions:  commits@horaedb.apache.org
+  discussions:  commits@horaedb.apache.org

.github/workflows/deploy-docs.yml

@@ -0,0 +1,57 @@
+name: Deploy Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - ".github/workflows/deploy-docs.yml"
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Cache Rust Dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo
+          key: docs-${{ runner.os }}
+      - name: Install mdbook
+        run: |
+          make install
+      - name: Build
+        run: |
+          make build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./docs/book/html
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

Makefile

@@ -1,5 +1,6 @@
 install:
-	cargo install mdbook@0.4.36
+	cargo install mdbook@0.4.25
+	cargo install mdbook-i18n --git https://github.com/chunshao90/mdbook-i18n.git --rev ca497cff369e0a5cedcd4024af6e1f05cc5050c5
 
 serve:
 	cd docs && mdbook serve

docs/book.toml

@@ -2,17 +2,26 @@
 authors = ["HoraeDB Authors"]
 language = "en"
 multilingual = true
-src = "src"
+src = "src/en"
 title = "HoraeDB Documentation"
 
 [build]
 use-default-preprocessors = false
 
 [preprocessor.links]
 
+[[output.i18n.translations]]
+src = "src/cn"
+language = "cn"
+translators = ["HoraeDB Authors"]
+title = "HoraeDB 文档"
+
+[output.random]
+command = "/bin/bash ../../move.sh"
+
 [output.html]
 git-repository-url = "https://github.com/apache/incubator-horaedb"
-edit-url-template = "https://github.com/apache/incubator-horaedb-docs/edit/main/docs/{path}"
+edit-url-template = "https://github.com/CeresDB/docs/edit/main/docs/{path}"
 additional-css = ["style.css"]
 additional-js = ["sidebar.js"]
 

docs/move.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+echo "ready to move files"
+cp -r ../i18n/cn ../html/cn
+cp -r ../i18n/en ../html/en
+cp -r ../../src/resources ../../book/html/resources
+echo "copy done"

docs/src/cn/SUMMARY.md

@@ -0,0 +1,66 @@
+# 目录
+
+# 简介
+
+- [什么是 HoraeDB](about.md)
+- [快速开始](quick_start.md)
+
+# 用户手册
+
+- [SQL 语法](sql/README.md)
+  - [数据模型](sql/model/README.md)
+    - [数据类型](sql/model/data_types.md)
+    - [特殊字段](sql/model/special_columns.md)
+  - [标识符](sql/identifier.md)
+  - [表结构操作](sql/ddl/README.md)
+    - [建表](sql/ddl/create_table.md)
+    - [表结构变更](sql/ddl/alter_table.md)
+    - [删除表](sql/ddl/drop_table.md)
+  - [数据操作](sql/dml/README.md)
+    - [数据写入](sql/dml/insert.md)
+    - [数据查询](sql/dml/select.md)
+  - [引擎配置](sql/engine_options.md)
+  - [常见 SQL](sql/utility.md)
+  - [标量函数](sql/functions/scalar_functions.md)
+  - [聚合函数](sql/functions/aggregate_functions.md)
+- [集群部署](cluster_deployment/README.md)
+  - [支持平台](cluster_deployment/platform.md)
+  - [NoMeta 模式](cluster_deployment/no_meta.md)
+  - [WithMeta 模式](cluster_deployment/with_meta.md)
+- [SDK](sdk/README.md)
+  - [Java SDK](sdk/java.md)
+  - [Go SDK](sdk/go.md)
+  - [Python SDK](sdk/python.md)
+  - [Rust SDK](sdk/rust.md)
+- [运维](operation/README.md)
+  - [表](operation/table.md)
+  - [系统表](operation/system_table.md)
+  - [黑名单](operation/block_list.md)
+  - [监控](operation/observability.md)
+  - [HoraeMeta](operation/horaemeta.md)
+- [周边生态](ecosystem/README.md)
+  - [Prometheus](ecosystem/prometheus.md)
+  - [InfluxDB](ecosystem/influxdb.md)
+  - [OpenTSDB](ecosystem/opentsdb.md)
+
+# 开发者手册
+
+- [支持平台](dev/platform.md)
+- [编译运行](dev/compile_run.md)
+  - [剖析](dev/profiling.md)
+- [开发规约](dev/conventional_commit.md)
+- [风格规范](dev/style_guide.md)
+- [里程碑](dev/roadmap.md)
+
+# 技术系列文章
+
+- [整体架构](design/architecture.md)
+- [集群](design/clustering.md)
+- [Shared-Nothing](design/shared_nothing.md)
+- [存储](design/storage.md)
+- [WAL](design/wal.md)
+  - [WAL on RocksDB](design/wal_on_rocksdb.md)
+  - [WAL on Kafka](design/wal_on_kafka.md)
+- [分区表](design/table_partitioning.md)
+
+[//]: # "- [查询介绍](query.md)"

docs/src/cn/about.md

@@ -0,0 +1,22 @@
+![HoraeDB](https://github.com/CeresDB/horaedb/raw/main/docs/logo/CeresDB.png)
+
+![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)
+[![CI](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml)
+[![OpenIssue](https://img.shields.io/github/issues/apachge/incubator-horaedb)](https://github.com/apache/incubator-horaedb/issues)
+
+HoraeDB 是一款高性能、分布式的云原生时序数据库。
+
+# 愿景
+
+在经典的时序数据库中，`Tag` 列（InfluxDB 称为 `Tag`，Prometheus 称为 `Label`）通常使用倒排来进行索引。
+我们发现在不同的情况下，`Tag` 的基数差异很大。在某些情况下，`Tag` 的基数非常高，存储和检索倒排索引的成本非常高。
+同时，我们发现分析型数据库经常使用的扫描+剪枝可以很好地处理这些场景。
+
+HoraeDB 的基础设计思想是采用混合存储格式和相应的查询方法，以便在处理时序和分析场景时都获得更好的性能。
+
+# 如何使用 HoraeDB？
+
+- 查看 [快速开始](quick_start.md) 掌握快速使用 HoraeDB 的方式
+- HoraeDB 支持的数据模型请查看 [Data Model](sql/model/README.md)
+- SQL 使用相关请查看 [SQL](sql/README.md)
+- HoraeDB 支持的相关 SDK 请查看 [SDK](sdk/README.md)

docs/src/cn/cluster_deployment/README.md

@@ -0,0 +1,10 @@
+# 集群部署
+
+在[快速开始](../quick_start.md)部分我们已经介绍过单机版本 HoraeDB 的部署。
+
+除此之外，HoraeDB 作为一个分布式时序数据库，多个 HoraeDB 实例能够以集群的方式提供可伸缩和高可用的数据服务。
+
+由于目前 HoraeDB 对于 Kubernetes 的支持还在开发之中，目前 HoraeDB 集群部署只能通过手动完成，集群部署的模式主要有两种，两者的区别在于是否需要部署 HoraeMeta，对于 `NoMeta` 的模式，我们仅建议在测试场景下使用。
+
+- [NoMeta 模式(仅供测试使用)](no_meta.md)
+- [WithMeta 模式](with_meta.md)