ci: deploy website

.asf.yaml

@@ -18,9 +18,8 @@
 # For more information, see https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features.
 
 github:
-  description: >-
-    HoraeDB Website.
-  homepage: https://apache.github.io/incubator-horaedb-docs # TODO: after website is ready, set to https://horaedb.apache.org/
+  description: HoraeDB Website.
+  homepage: https://horaedb.apache.org/
   labels:
     - rust
     - sql
@@ -41,10 +40,14 @@ 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.yml

@@ -0,0 +1,29 @@
+name: Deploy Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    deploy: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: make install
+      - run: make build
+      - uses: peaceiris/actions-gh-pages@v3
+        if: github.event_name != 'pull_request'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book
+          publish_branch: asf-site

Makefile

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

docs/book.toml

@@ -2,26 +2,17 @@
 authors = ["HoraeDB Authors"]
 language = "en"
 multilingual = true
-src = "src/en"
+src = "src"
 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/CeresDB/docs/edit/main/docs/{path}"
+edit-url-template = "https://github.com/apache/incubator-horaedb-docs/edit/main/docs/{path}"
 additional-css = ["style.css"]
 additional-js = ["sidebar.js"]
 

docs/src/.asf.yaml

@@ -0,0 +1,53 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# For more information, see https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features.
+
+github:
+  description: HoraeDB Website.
+  homepage: https://horaedb.apache.org/
+  labels:
+    - rust
+    - sql
+    - database
+    - distributed-database
+    - cloud-native
+    - tsdb
+    - timeseries-database
+    - timeseries-analysis
+    - iot-database
+    - horaedb
+  enabled_merge_buttons:
+    squash:  true
+    merge:   false
+    rebase:  true
+  protected_branches:
+    main:
+      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

docs/src/en/about.md → docs/src/about.md

@@ -1,8 +1,6 @@
-![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/CeresDB/horaedb)](https://github.com/apache/incubator-horaedb/issues)
+[![OpenIssue](https://img.shields.io/github/issues/apache/incubator-horaedb)](https://github.com/apache/incubator-horaedb/issues)
 
 HoraeDB is a high-performance, distributed, cloud native time-series database.
 

docs/src/en/cluster_deployment/with_meta.md → docs/src/cluster_deployment/with_meta.md

@@ -253,9 +253,9 @@ memory_limit = "4G"
 
 Let's name this config file as `config.toml`. And the example configs, in which the templates must be replaced with real parameters before use, for remote storages are also provided:
 
-- [RocksDB WAL + OSS](../../resources/config_local_oss.toml)
-- [OceanBase WAL + OSS](../../resources/config_obkv_oss.toml)
-- [Kafka WAL + OSS](../../resources/config_kafka_oss.toml)
+- [RocksDB WAL + OSS](../resources/config_local_oss.toml)
+- [OceanBase WAL + OSS](../resources/config_obkv_oss.toml)
+- [Kafka WAL + OSS](../resources/config_kafka_oss.toml)
 
 ## Run HoraeDB cluster with HoraeMeta