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]> 89a0a1a
apache · Jan 1, 2023 · c365f3c · c365f3c
1 parent 12de13b
commit c365f3c
Show file tree

Hide file tree

Showing 210 changed files with 1,535 additions and 2,249 deletions.
diff --git a/404.html b/404.html
diff --git a/blog/2018/01/04/another-great-release/index.html b/blog/2018/01/04/another-great-release/index.html
diff --git a/blog/2018/10/06/easy-documentation-with-docsy/index.html b/blog/2018/10/06/easy-documentation-with-docsy/index.html
diff --git a/blog/2018/10/06/the-second-blog-post/index.html b/blog/2018/10/06/the-second-blog-post/index.html
diff --git a/blog/_print/index.html b/blog/_print/index.html
diff --git a/blog/index.html b/blog/index.html
diff --git a/blog/news/_print/index.html b/blog/news/_print/index.html
diff --git a/blog/news/index.html b/blog/news/index.html
diff --git a/blog/releases/_print/index.html b/blog/releases/_print/index.html
diff --git a/blog/releases/index.html b/blog/releases/index.html
diff --git a/categories/index.html b/categories/index.html
diff --git a/cn/404.html b/cn/404.html
diff --git a/cn/blog/2018/01/04/another-great-release/index.html b/cn/blog/2018/01/04/another-great-release/index.html
diff --git a/cn/blog/2018/10/06/easy-documentation-with-docsy/index.html b/cn/blog/2018/10/06/easy-documentation-with-docsy/index.html
diff --git a/cn/blog/2018/10/06/the-second-blog-post/index.html b/cn/blog/2018/10/06/the-second-blog-post/index.html
diff --git a/cn/blog/_print/index.html b/cn/blog/_print/index.html
diff --git a/cn/blog/index.html b/cn/blog/index.html
diff --git a/cn/blog/news/_print/index.html b/cn/blog/news/_print/index.html
diff --git a/cn/blog/news/index.html b/cn/blog/news/index.html
diff --git a/cn/blog/releases/_print/index.html b/cn/blog/releases/_print/index.html
diff --git a/cn/blog/releases/index.html b/cn/blog/releases/index.html
diff --git a/cn/categories/index.html b/cn/categories/index.html
diff --git a/cn/community/_print/index.html b/cn/community/_print/index.html
diff --git a/cn/community/index.html b/cn/community/index.html
diff --git a/cn/docs/_print/index.html b/cn/docs/_print/index.html
diff --git a/cn/docs/changelog/_print/index.html b/cn/docs/changelog/_print/index.html
diff --git a/cn/docs/changelog/hugegraph-0.10.4-release-notes/index.html b/cn/docs/changelog/hugegraph-0.10.4-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.11.2-release-notes/index.html b/cn/docs/changelog/hugegraph-0.11.2-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.12.0-release-notes/index.html b/cn/docs/changelog/hugegraph-0.12.0-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.2-release-notes/index.html b/cn/docs/changelog/hugegraph-0.2-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.2.4-release-notes/index.html b/cn/docs/changelog/hugegraph-0.2.4-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.3.3-release-notes/index.html b/cn/docs/changelog/hugegraph-0.3.3-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.4.4-release-notes/index.html b/cn/docs/changelog/hugegraph-0.4.4-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.5.6-release-notes/index.html b/cn/docs/changelog/hugegraph-0.5.6-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.6.1-release-notes/index.html b/cn/docs/changelog/hugegraph-0.6.1-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.7.4-release-notes/index.html b/cn/docs/changelog/hugegraph-0.7.4-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.8.0-release-notes/index.html b/cn/docs/changelog/hugegraph-0.8.0-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-0.9.2-release-notes/index.html b/cn/docs/changelog/hugegraph-0.9.2-release-notes/index.html
diff --git a/cn/docs/changelog/hugegraph-1.0.0-release-notes/index.html b/cn/docs/changelog/hugegraph-1.0.0-release-notes/index.html
diff --git a/cn/docs/changelog/index.html b/cn/docs/changelog/index.html
diff --git a/cn/docs/changelog/index.xml b/cn/docs/changelog/index.xml
diff --git a/cn/docs/cla/index.html b/cn/docs/cla/index.html
diff --git a/cn/docs/clients/_print/index.html b/cn/docs/clients/_print/index.html
diff --git a/cn/docs/clients/gremlin-console/index.html b/cn/docs/clients/gremlin-console/index.html
diff --git a/cn/docs/clients/hugegraph-client/index.html b/cn/docs/clients/hugegraph-client/index.html
diff --git a/cn/docs/clients/index.html b/cn/docs/clients/index.html
diff --git a/cn/docs/clients/restful-api/_print/index.html b/cn/docs/clients/restful-api/_print/index.html
diff --git a/cn/docs/clients/restful-api/auth/index.html b/cn/docs/clients/restful-api/auth/index.html
diff --git a/cn/docs/clients/restful-api/edge/index.html b/cn/docs/clients/restful-api/edge/index.html
diff --git a/cn/docs/clients/restful-api/edgelabel/index.html b/cn/docs/clients/restful-api/edgelabel/index.html
diff --git a/cn/docs/clients/restful-api/graphs/index.html b/cn/docs/clients/restful-api/graphs/index.html
diff --git a/cn/docs/clients/restful-api/gremlin/index.html b/cn/docs/clients/restful-api/gremlin/index.html
diff --git a/cn/docs/clients/restful-api/index.html b/cn/docs/clients/restful-api/index.html
diff --git a/cn/docs/clients/restful-api/indexlabel/index.html b/cn/docs/clients/restful-api/indexlabel/index.html
diff --git a/cn/docs/clients/restful-api/other/index.html b/cn/docs/clients/restful-api/other/index.html
diff --git a/cn/docs/clients/restful-api/propertykey/index.html b/cn/docs/clients/restful-api/propertykey/index.html
diff --git a/cn/docs/clients/restful-api/rank/index.html b/cn/docs/clients/restful-api/rank/index.html
diff --git a/cn/docs/clients/restful-api/rebuild/index.html b/cn/docs/clients/restful-api/rebuild/index.html
diff --git a/cn/docs/clients/restful-api/schema/index.html b/cn/docs/clients/restful-api/schema/index.html
diff --git a/cn/docs/clients/restful-api/task/index.html b/cn/docs/clients/restful-api/task/index.html
diff --git a/cn/docs/clients/restful-api/traverser/index.html b/cn/docs/clients/restful-api/traverser/index.html
diff --git a/cn/docs/clients/restful-api/variable/index.html b/cn/docs/clients/restful-api/variable/index.html
diff --git a/cn/docs/clients/restful-api/vertex/index.html b/cn/docs/clients/restful-api/vertex/index.html
diff --git a/cn/docs/clients/restful-api/vertexlabel/index.html b/cn/docs/clients/restful-api/vertexlabel/index.html
diff --git a/cn/docs/config/_print/index.html b/cn/docs/config/_print/index.html
diff --git a/cn/docs/config/config-authentication/index.html b/cn/docs/config/config-authentication/index.html
diff --git a/cn/docs/config/config-computer/index.html b/cn/docs/config/config-computer/index.html
diff --git a/cn/docs/config/config-guide/index.html b/cn/docs/config/config-guide/index.html
diff --git a/cn/docs/config/config-https/index.html b/cn/docs/config/config-https/index.html
diff --git a/cn/docs/config/config-option/index.html b/cn/docs/config/config-option/index.html
diff --git a/cn/docs/config/index.html b/cn/docs/config/index.html
diff --git a/cn/docs/config/index.xml b/cn/docs/config/index.xml
@@ -2036,7 +2036,7 @@ auth.user_tokens=[hugegraph1:token-value-1, hugegraph2:token-value-2]
 &lt;/table>
 &lt;h3 id="k8s-operator-config-options">K8s Operator Config Options&lt;/h3>
 &lt;blockquote>
-&lt;p>NOTE: Option needs to be converted through environment variable settings, e.g k8s.internal_etcd_url =&amp;gt; INTERNAL_ETCD_URL&lt;/p>
+&lt;p>NOTE: Option needs to be converted through environment variable settings, e.g. k8s.internal_etcd_url =&amp;gt; INTERNAL_ETCD_URL&lt;/p>
 &lt;/blockquote>
 &lt;table>
 &lt;thead>

diff --git a/cn/docs/contribution-guidelines/_print/index.html b/cn/docs/contribution-guidelines/_print/index.html
diff --git a/cn/docs/contribution-guidelines/contribute/index.html b/cn/docs/contribution-guidelines/contribute/index.html
diff --git a/cn/docs/contribution-guidelines/index.html b/cn/docs/contribution-guidelines/index.html
diff --git a/cn/docs/contribution-guidelines/index.xml b/cn/docs/contribution-guidelines/index.xml
@@ -210,8 +210,11 @@
 &lt;li>检查前 3 ~ 5 个 commit 提交, 点进去看看是否修改处和源码文件一致&lt;/li>
 &lt;li>最后, 确保源码可以正常/正确编译 (然后看看测试和规范)&lt;/li>
 &lt;/ol>
-&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#8f5902;font-style:italic"># 同时也可以检查一下代码风格是否符合规范, 不符合的可以放下一次调整&lt;/span>
-&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>mvn clean package -Dmaven.test.skip&lt;span style="color:#ce5c00;font-weight:bold">=&lt;/span>&lt;span style="color:#204a87">true&lt;/span> -Dcheckstyle.skip&lt;span style="color:#ce5c00;font-weight:bold">=&lt;/span>&lt;span style="color:#204a87">false&lt;/span>
+&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#8f5902;font-style:italic"># 请优先使用/切换到 java 11 版本进行后序的编译和运行操作&lt;/span>
+&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#8f5902;font-style:italic"># java --version&lt;/span>
+&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>
+&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#8f5902;font-style:italic"># 尝试在 Unix 环境下编译测试是否正常&lt;/span>
+&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>mvn clean package -Dmaven.test.skip&lt;span style="color:#ce5c00;font-weight:bold">=&lt;/span>&lt;span style="color:#204a87">true&lt;/span> -Dcheckstyle.skip&lt;span style="color:#ce5c00;font-weight:bold">=&lt;/span>&lt;span style="color:#204a87">true&lt;/span>
 &lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h5 id="b-二进制包">B. 二进制包&lt;/h5>
 &lt;p>解压 &lt;code>xxx-hugegraph.tar.gz&lt;/code>后, 进行如下检查:&lt;/p>
 &lt;ol>

diff --git a/cn/docs/contribution-guidelines/subscribe/index.html b/cn/docs/contribution-guidelines/subscribe/index.html
diff --git a/cn/docs/contribution-guidelines/validate-release/index.html b/cn/docs/contribution-guidelines/validate-release/index.html
diff --git a/cn/docs/download/download/index.html b/cn/docs/download/download/index.html
diff --git a/cn/docs/guides/_print/index.html b/cn/docs/guides/_print/index.html
diff --git a/cn/docs/guides/architectural/index.html b/cn/docs/guides/architectural/index.html
diff --git a/cn/docs/guides/backup-restore/index.html b/cn/docs/guides/backup-restore/index.html
diff --git a/cn/docs/guides/custom-plugin/index.html b/cn/docs/guides/custom-plugin/index.html
diff --git a/cn/docs/guides/desgin-concept/index.html b/cn/docs/guides/desgin-concept/index.html
diff --git a/cn/docs/guides/faq/index.html b/cn/docs/guides/faq/index.html
diff --git a/cn/docs/guides/index.html b/cn/docs/guides/index.html
diff --git a/cn/docs/guides/index.xml b/cn/docs/guides/index.xml
@@ -1,14 +1,14 @@
 <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>HugeGraph – GUIDES</title><link>/cn/docs/guides/</link><description>Recent content in GUIDES on HugeGraph</description><generator>Hugo -- gohugo.io</generator><atom:link href="/cn/docs/guides/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: HugeGraph Architecture Overview</title><link>/cn/docs/guides/architectural/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/cn/docs/guides/architectural/</guid><description>
 &lt;h3 id="1-概述">1 概述&lt;/h3>
 &lt;p>作为一款通用的图数据库产品，HugeGraph需具备图数据的基本功能，如下图所示。HugeGraph包括三个层次的功能，分别是存储层、计算层和用户接口层。 HugeGraph支持OLTP和OLAP两种图计算类型，其中OLTP实现了&lt;a href="https://tinkerpop.apache.org">Apache TinkerPop3&lt;/a>框架，并支持&lt;a href="https://tinkerpop.apache.org/gremlin.html">Gremlin&lt;/a>查询语言。 OLAP计算是基于SparkGraphX实现。&lt;/p>
-&lt;center>
+&lt;div style="text-align: center;">
 &lt;img src="/docs/images/design/architectural-overview.png" alt="image">
-&lt;/center>
+&lt;/div>
 &lt;h3 id="2-组件">2 组件&lt;/h3>
 &lt;p>HugeGraph的主要功能分为HugeCore、ApiServer、HugeGraph-Client、HugeGraph-Loader和HugeGraph-Studio等组件构成，各组件之间的通信关系如下图所示。&lt;/p>
-&lt;center>
+&lt;div style="text-align: center;">
 &lt;img src="/docs/images/design/architectural-component.png" alt="image">
-&lt;/center>
+&lt;/div>
 &lt;ul>
 &lt;li>HugeCore ：HugeGraph的核心模块，TinkerPop的接口主要在该模块中实现。HugeCore的功能涵盖包括OLTP和OLAP两个部分。&lt;/li>
 &lt;li>ApiServer ：提供RESTFul Api接口，对外提供Graph Api、Schema Api和Gremlin Api等接口服务。&lt;/li>
@@ -574,7 +574,7 @@ HugeGraph目前采用EdgeCut的分区方案。&lt;/p>
 &lt;/li>
 &lt;li>
 &lt;p>启动服务时提示：&lt;code>xxx (core dumped) xxx&lt;/code>&lt;/p>
-&lt;p>请检查JDK版本是否为1.8&lt;/p>
+&lt;p>请检查JDK版本是否为 Java11 (至少是Java8)&lt;/p>
 &lt;/li>
 &lt;li>
 &lt;p>启动服务成功了，但是操作图时有类似于&amp;quot;无法连接到后端或连接未打开&amp;quot;的提示&lt;/p>

diff --git a/cn/docs/index.html b/cn/docs/index.html