enhance validate doc (#171)

* enhance validate doc * format a lot of tables * use java 11 as the 1st priority choose Co-authored-by: imbajin <[email protected]>
apache · Jan 1, 2023 · 89a0a1a · 89a0a1a
1 parent 26a13de
commit 89a0a1a
Show file tree

Hide file tree

Showing 38 changed files with 557 additions and 549 deletions.
diff --git a/.asf.yaml b/.asf.yaml
@@ -42,7 +42,7 @@ github:
  protected_branches:
  master:
  required_status_checks:
- # strict means "Require branches to be up to date before merging".
+ # strict means "Require branches to be up-to-date before merging".
  #strict: true
  contexts:
  - deploy

diff --git a/.github/workflows/hugo.yml b/.github/workflows/hugo.yml
@@ -38,7 +38,7 @@ jobs:
  fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
 
  - name: Setup Node
- uses: actions/setup-node@v2.4.0
+ uses: actions/setup-node@v3
  with:
  node-version: "16"
 
@@ -48,7 +48,7 @@ jobs:
  hugo-version: '0.102.3'
  extended: true
 
- - uses: actions/cache@v2
+ - uses: actions/cache@v3
  with:
  path: /tmp/hugo_cache
  key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}

diff --git a/content/cn/about/_index.html b/content/cn/about/_index.html
@@ -1,6 +1,7 @@
 ---
 title: About HugeGraph
 linkTitle: About
+draft: true
 menu:
  main:
  weight: 10

diff --git a/content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md b/content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md
@@ -1,7 +1,7 @@
 ---
 title: "HugeGraph 0.12 Release Notes"
 linkTitle: "Release-0.12.0"
-weight: 1
+weight: 2
 ---
 
 ### API & Client

diff --git a/content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md b/content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md
@@ -1,7 +1,7 @@
 ---
 title: "HugeGraph 1.0.0 Release Notes"
 linkTitle: "Release-1.0.0"
-weight: 0
+weight: 1
 ---
 
 > TODO: update the summary soon, please check the detail in each repository first, thanks

diff --git a/content/cn/docs/config/config-computer.md b/content/cn/docs/config/config-computer.md
diff --git a/content/cn/docs/config/config-option.md b/content/cn/docs/config/config-option.md
@@ -8,7 +8,7 @@ weight: 2
 
 对应配置文件`gremlin-server.yaml`
 
-| config option | default value | description  |
+| config option | default value | description |
 |-------------------------|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
 | host | 127.0.0.1 | The host or ip of Gremlin Server. |
 | port | 8182 | The listening port of Gremlin Server. |
@@ -21,7 +21,7 @@ weight: 2
 
 对应配置文件`rest-server.properties`
 
-| config option | default value | description  |
+| config option | default value | description |
 |------------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | graphs | [hugegraph:conf/hugegraph.properties] | The map of graphs' name and config file. |
 | server.id | server-1 | The id of rest server, used for license verification. |
@@ -41,7 +41,7 @@ weight: 2
 | batch.max_vertices_per_batch | 500 | The maximum number of vertices submitted per batch. |
 | batch.max_write_ratio | 50 | The maximum thread ratio for batch writing, only take effect if the batch.max_write_threads is 0. |
 | batch.max_write_threads | 0 | The maximum threads for batch writing, if the value is 0, the actual value will be set to batch.max_write_ratio * restserver.max_worker_threads. |
-| auth.authenticator | | The class path of authenticator implementation. e.g., com.baidu.hugegraph.auth.StandardAuthenticator, or com.baidu.hugegraph.auth.ConfigAuthenticator.  |
+| auth.authenticator | | The class path of authenticator implementation. e.g., com.baidu.hugegraph.auth.StandardAuthenticator, or com.baidu.hugegraph.auth.ConfigAuthenticator. |
 | auth.admin_token | 162f7848-0b6d-4faf-b557-3a0797869c55 | Token for administrator operations, only for com.baidu.hugegraph.auth.ConfigAuthenticator. |
 | auth.graph_store | hugegraph | The name of graph used to store authentication information, like users, only for com.baidu.hugegraph.auth.StandardAuthenticator. |
 | auth.user_tokens | [hugegraph:9fd95c9c-711b-415b-b85f-d4df46ba5c31] | The map of user tokens with name and password, only for com.baidu.hugegraph.auth.ConfigAuthenticator. |
@@ -57,7 +57,7 @@ weight: 2
 
 基本配置项及后端配置项对应配置文件：{graph-name}.properties，如`hugegraph.properties`
 
-| config option | default value | description  |
+| config option | default value | description |
 |---------------------------------------|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | gremlin.graph | com.baidu.hugegraph.HugeFactory | Gremlin entrance to create graph. |
 | backend | rocksdb | The data store type, available values are [memory, rocksdb, cassandra, scylladb, hbase, mysql]. |
@@ -149,7 +149,7 @@ weight: 2
 
 ### Cassandra 后端配置项
 
-| config option | default value | description  |
+| config option | default value | description |
 |--------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------|
 | backend | | Must be set to `cassandra`. |
 | serializer | | Must be set to `cassandra`. |
@@ -167,7 +167,7 @@ weight: 2
 
 ### ScyllaDB 后端配置项
 
-| config option | default value | description  |
+| config option | default value | description |
 |---------------|---------------|----------------------------|
 | backend | | Must be set to `scylladb`. |
 | serializer | | Must be set to `scylladb`. |
@@ -176,7 +176,7 @@ weight: 2
 
 ### RocksDB 后端配置项
 
-| config option | default value | description  |
+| config option | default value | description |
 |-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | backend | | Must be set to `rocksdb`. |
 | serializer | | Must be set to `binary`. |
@@ -230,7 +230,7 @@ weight: 2
 
 ### HBase 后端配置项
 
-| config option | default value | description  |
+| config option | default value | description |
 |---------------------------|--------------------------------|--------------------------------------------------------------------------|
 | backend | | Must be set to `hbase`. |
 | serializer | | Must be set to `hbase`. |
@@ -251,7 +251,7 @@ weight: 2
 
 ### MySQL & PostgreSQL 后端配置项
 
-| config option | default value | description  |
+| config option | default value | description |
 |----------------------------------|-----------------------------|-------------------------------------------------------------------------------------|
 | backend | | Must be set to `mysql`. |
 | serializer | | Must be set to `mysql`. |
@@ -267,7 +267,7 @@ weight: 2
 
 ### PostgreSQL 后端配置项
 
-| config option | default value | description  |
+| config option | default value | description |
 |---------------|---------------|------------------------------|
 | backend | | Must be set to `postgresql`. |
 | serializer | | Must be set to `postgresql`. |

diff --git a/content/cn/docs/contribution-guidelines/validate-release.md b/content/cn/docs/contribution-guidelines/validate-release.md
@@ -99,8 +99,11 @@ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
 8. 最后, 确保源码可以正常/正确编译 (然后看看测试和规范)
 
 ```bash
-# 同时也可以检查一下代码风格是否符合规范, 不符合的可以放下一次调整
-mvn clean package -Dmaven.test.skip=true -Dcheckstyle.skip=false
+# 请优先使用/切换到 java 11 版本进行后序的编译和运行操作
+# java --version
+
+# 尝试在 Unix 环境下编译测试是否正常
+mvn clean package -Dmaven.test.skip=true -Dcheckstyle.skip=true
 ```
 
 ##### B. 二进制包