move architeture to user-guide

apache · Aug 10, 2022 · 1d28275 · 1d28275
1 parent 91553aa
commit 1d28275
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 305 deletions.
diff --git a/.github/workflows/user_guide.yml b/.github/workflows/user_guide.yml
@@ -35,8 +35,6 @@ jobs:
         git update-ref -d refs/heads/gh-pages
         rm -rf *
         mv ../book/* .
-        # Add custom domain
-        echo "docs.ceresdb.io" > CNAME
         git add .
         git commit -m "Deploy $GITHUB_SHA to gh-pages"
         git push --force
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ The project is currently under rapid development. This early stage is not produc
 
 See our [RoadMap](./docs/dev/roadmap.md)
 
-## User Guide
+## Documentation
 See https://docs.ceresdb.io/
 
 ## Develop
@@ -64,24 +64,11 @@ Then you can run CeresDB using the default configuration file provided in the co
 ./target/release/ceresdb-server --config ./docs/example.toml
 ```
 
-## Platform Support
-
-|          target          |         OS        |         status        |
-|:------------------------:|:-----------------:|:---------------------:|
-| x86_64-unknown-linux-gnu |    kernel 4.9+    | able to build and run |
-|    x86_64-apple-darwin   | 10.15+, Catalina+ |     able to build     |
-|    aarch64-apple-darwin  |   11+, Big Sur+   |     able to build     |
-| aarch64-unknown-linux-gnu|        TBD        | tracked on [#63](https://github.com/CeresDB/ceresdb/issues/63)|
-|         *-windows        |         *         |      not support      |
-
 ## Contributing
 Any contribution is welcome!
 
 Read our [Contributing Guide](CONTRIBUTING.md) and make your first contribution!
 
-## Architecture and Technical Documentation
-Our technical documents(still under writing and polishing) describes critical parts of ceresdb in the [docs](docs).
-
 ## Acknowledgment
 Some design of CeresDB references [influxdb_iox](https://github.com/influxdata/influxdb_iox), and some specific module implementations reference [tikv](https://github.com/tikv/tikv) and other excellent open source projects, thanks to InfluxDB, TiKV, and any other referenced great open source projects.
 

diff --git a/docs/dev/architeture.md b/docs/dev/architeture.md
diff --git a/docs/dev/conventional-commit.md b/docs/dev/conventional-commit.md
@@ -16,6 +16,7 @@ There are three parts. `type` is used to classify which kind of work this commit
 Here we list some common `type`s and their meanings.
 
 - `feat`: Implement a new feature.
+- `fix`: Patch a bug.
 - `docs`: Add document or comment.
 - `build`: Change the build script or configuration.
 - `style`: Style change (only). No logic involved.
@@ -30,7 +31,7 @@ The `scope` is more flexible than `type`. And it may have different values under
 For example, In a `feat` or `build` commit we may use the code module to define scope, like
 
 ```
-feat(cluster): 
+feat(cluster):
 feat(server):
 
 build(ci):
@@ -51,4 +52,4 @@ But you don't need to add a scope every time. This isn't mandatory. It's just a
 
 # After all
 
-There are many other rules or scenarios in [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)'s website. We are still exploring a better and more friendly workflow. Please do let us know by [open an issue](https://github.com/CeresDB/ceresdb/issues/new/choose) if you have any suggestions ❤️
+There are many other rules or scenarios in [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)'s website. We are still exploring a better and more friendly workflow. Please do let us know by [open an issue](https://github.com/CeresDB/ceresdb/issues/new/choose) if you have any suggestions ❤️
diff --git a/docs/dockerhub-description.md b/docs/dockerhub-description.md
@@ -35,5 +35,5 @@ docker run -d --name ceresdb-server \
   ceresdb/ceresdb-server:v0.2.0
 ```
 
-# Write and read data
-- [Quick Start](https://github.com/CeresDB/ceresdb/blob/main/docs/user-guide/src/quick_start.md)
+# Documentation
+- https://docs.ceresdb.io/
diff --git a/docs/user-guide/book.toml b/docs/user-guide/book.toml
@@ -3,4 +3,10 @@ authors = ["CeresDB Authors"]
 language = "en"
 multilingual = false
 src = "src"
-title = "CeresDB User Guide"
+title = "CeresDB Documentation"
+
+[output.html]
+cname = "docs.ceresdb.io"
+
+[output.html.fold]
+enable = true
diff --git a/docs/user-guide/src/SUMMARY.md b/docs/user-guide/src/SUMMARY.md
@@ -22,10 +22,15 @@
 - [Analytic Engine](analytic_engine/README.md)
     - [Options](analytic_engine/options.md)
 - [Deployment](deploy/README.md)
+    - [Supported Platform](deploy/platform.md)
     - [Static Routing](deploy/static_routing.md)
 - [Develop Kits](sdk.md)
 - [Protocol](protocol.md)
 
+# Technical and Design
+- [Architecture](architecture.md)
+
+
 -----
 
 - [Trouble Shooting](trouble_shooting.md)
diff --git a/docs/user-guide/src/deploy/platform.md b/docs/user-guide/src/deploy/platform.md
@@ -0,0 +1,8 @@
+
+|          target          |         OS        |         status        |
+|:------------------------:|:-----------------:|:---------------------:|
+| x86_64-unknown-linux-gnu |    kernel 4.9+    | able to build and run |
+|    x86_64-apple-darwin   | 10.15+, Catalina+ |     able to build     |
+|    aarch64-apple-darwin  |   11+, Big Sur+   |     able to build     |
+| aarch64-unknown-linux-gnu|        TBD        | tracked on [#63](https://github.com/CeresDB/ceresdb/issues/63)|
+|         *-windows        |         *         |      not support      |