[Doc]: Upgrade open source documentation (#357)

README.md

@@ -1,4 +1,4 @@
-# TuGraph Analytics
+# Guide
 
 [![Star](https://shields.io/github/stars/tugraph-family/tugraph-analytics?logo=startrek&label=Star&color=yellow)](https://github.com/TuGraph-family/tugraph-analytics/stargazers)
 [![Fork](https://shields.io/github/forks/tugraph-family/tugraph-analytics?logo=forgejo&label=Fork&color=orange)](https://github.com/TuGraph-family/tugraph-analytics/forks)
@@ -17,7 +17,7 @@
 ## Introduction
 **TuGraph Analytics** (alias: GeaFlow) is a distributed graph compute engine developed by Ant Group. It supports core capabilities such as trillion-level graph storage, hybrid graph and table processing, real-time graph computation, and interactive graph analysis. Currently, it is widely used in scenarios such as data warehousing acceleration, financial risk control, knowledge graph, and social networks.
 
-For more information about GeaFlow: [GeaFlow Introduction](docs/docs-en/introduction.md)
+For more information about GeaFlow: [GeaFlow Introduction](docs/docs-en/source/2.introduction.md)
 
 For GeaFlow design paper: [GeaFlow: A Graph Extended and Accelerated Dataflow System](https://dl.acm.org/doi/abs/10.1145/3589771)
 
@@ -43,21 +43,21 @@ For GeaFlow design paper: [GeaFlow: A Graph Extended and Accelerated Dataflow Sy
 3. Build Image：`./build.sh --all`
 4. Start Container：`docker run -d --name geaflow-console -p 8888:8888 geaflow-console:0.1`
 
-For more details：[Quick Start](docs/docs-cn/quick_start.md)。
+For more details：[Quick Start](docs/docs-cn/source/3.quick_start/1.quick_start.md)。
 
 ## Development Manual
 
 GeaFlow supports two sets of programming interfaces: DSL and API. You can develop streaming graph computing jobs using GeaFlow's SQL extension language SQL+ISO/GQL or use GeaFlow's high-level API programming interface to develop applications in Java.
-* DSL application development: [DSL Application Development](docs/docs-en/application-development/dsl/overview.md)
-* API application development: [API Application Development](docs/docs-en/application-development/api/overview.md)
+* DSL application development: [DSL Application Development](docs/docs-en/source/5.application-development/2.dsl/1.overview.md)
+* API application development: [API Application Development](docs/docs-en/source/5.application-development/1.api/1.overview.md)
 
 ## Real-time Capabilities
 
 Compared with traditional stream processing engines such as Flink and Storm, which use tables as their data model for real-time processing, GeaFlow's graph-based data model has significant performance advantages when handling join relationship operations, especially complex multi-hops relationship operations like those involving 3 or more hops of join and complex loop searches.
 
-[![total_time](./docs/static/img/vs_join_total_time_en.jpg)](./docs/docs-en/principle/vs_join.md)
+[![total_time](docs/static/img/vs_join_total_time_en.jpg)](docs/docs-en/source/reference/vs_join.md)
 
-[Why using graphs for relational operations is more appealing than table joins?](./docs/docs-en/principle/vs_join.md)
+[Why using graphs for relational operations is more appealing than table joins?](docs/docs-en/source/reference/vs_join.md)
 
 Association Analysis Demo Based on GQL:
 
@@ -82,7 +82,7 @@ JOIN student s ON sc.srcId = s.id
 ## Contribution
 Thank you very much for contributing to GeaFlow, whether bug reporting, documentation improvement, or major feature development, we warmly welcome all contributions. 
 
-For more information: [Contribution](docs/docs-en/contribution.md).
+For more information: [Contribution](docs/docs-en/source/9.contribution.md).
 
 ## Contact Us
 You can contact us through the following methods:

README_cn.md

@@ -1,4 +1,4 @@
-# TuGraph Analytics
+# TuGraph Analytics 文档地图
 
 [![Star](https://shields.io/github/stars/tugraph-family/tugraph-analytics?logo=startrek&label=Star&color=yellow)](https://github.com/TuGraph-family/tugraph-analytics/stargazers)
 [![Fork](https://shields.io/github/forks/tugraph-family/tugraph-analytics?logo=forgejo&label=Fork&color=orange)](https://github.com/TuGraph-family/tugraph-analytics/forks)
@@ -17,7 +17,7 @@
 ## 介绍
 **TuGraph Analytics** (别名：GeaFlow) 是蚂蚁集团开源的流图计算引擎，支持万亿级图存储、图表混合处理、实时图计算、交互式图分析等核心能力，目前广泛应用于数仓加速、金融风控、知识图谱以及社交网络等场景。
 
-关于GeaFlow更多介绍请参考：[GeaFlow介绍文档](docs/docs-cn/introduction.md)
+关于GeaFlow更多介绍请参考：[GeaFlow介绍文档](docs/docs-cn/source/2.introduction.md)
 
 GeaFlow设计论文参考：[GeaFlow: A Graph Extended and Accelerated Dataflow System](https://dl.acm.org/doi/abs/10.1145/3589771)
 
@@ -43,21 +43,21 @@ GeaFlow设计论文参考：[GeaFlow: A Graph Extended and Accelerated Dataflow
 3. 构建镜像：`./build.sh --all`
 4. 启动容器：`docker run -d --name geaflow-console -p 8888:8888 geaflow-console:0.1`
 
-更多详细内容请参考：[快速上手文档](docs/docs-cn/quick_start.md)。
+更多详细内容请参考：[快速上手文档](docs/docs-cn/source/3.quick_start/1.quick_start.md)。
 
 ## 开发手册
 
 GeaFlow支持DSL和API两套编程接口，您既可以通过GeaFlow提供的类SQL扩展语言SQL+ISO/GQL进行流图计算作业的开发，也可以通过GeaFlow的高阶API编程接口通过Java语言进行应用开发。
-* DSL应用开发：[DSL开发文档](docs/docs-cn/application-development/dsl/overview.md)
-* API应用开发：[API开发文档](docs/docs-cn/application-development/api/guid.md)
+* DSL应用开发：[DSL开发文档](docs/docs-cn/source/5.application-development/2.dsl/1.overview.md)
+* API应用开发：[API开发文档](docs/docs-cn/source/5.application-development/1.api/guid.md)
 
 ## 实时能力
 
 相比传统的流式计算引擎比如Flink、Storm这些以表为模型的实时处理系统而言，GeaFlow以图为数据模型，在处理Join关系运算，尤其是复杂多跳的关系运算如3跳以上的Join、复杂环路查找上具备极大的性能优势。
 
-[![total_time](./docs/static/img/vs_join_total_time_cn.jpg)](./docs/docs-cn/principle/vs_join.md)
+[![total_time](docs/static/img/vs_join_total_time_cn.jpg)](docs/docs-cn/source/reference/vs_join.md)
 
-[为什么使用图进行关联运算比表Join更具吸引力？](./docs/docs-cn/principle/vs_join.md)
+[为什么使用图进行关联运算比表Join更具吸引力？](docs/docs-cn/source/reference/vs_join.md)
 
 基于GQL的关联分析Demo：
 
@@ -82,7 +82,7 @@ JOIN student s ON sc.srcId = s.id
 ## 参与贡献
 非常感谢您参与到GeaFlow的贡献中来，无论是Bug反馈还是文档完善，或者是大的功能点贡献，我们都表示热烈的欢迎。
 
-具体请参考：[参与贡献文档](docs/docs-cn/contribution.md)。
+具体请参考：[参与贡献文档](docs/docs-cn/source/9.contribution.md)。
 
 **如果您对GeaFlow感兴趣，欢迎给我们项目一颗[ ⭐️ ](https://github.com/TuGraph-family/tugraph-analytics)。**
 

docs/docs-cn/.readthedocs.yaml

@@ -0,0 +1,30 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.6"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/docs-cn/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/docs-cn/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/docs-cn/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXOPTS=-W
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/docs-cn/source/1.guide_cn.md

@@ -0,0 +1,41 @@
+# 文档地图
+这里是文档地图，帮助用户快速学习和使用TuGraph Analytics。
+
+## 介绍
+**TuGraph Analytics** (别名：GeaFlow) 是蚂蚁集团开源的[**性能世界一流**](https://ldbcouncil.org/benchmarks/snb-bi/)的OLAP图数据库，支持万亿级图存储、图表混合处理、实时图计算、交互式图分析等核心能力，目前广泛应用于数仓加速、金融风控、知识图谱以及社交网络等场景。
+
+关于GeaFlow更多介绍请参考：[GeaFlow介绍文档](2.introduction.md)
+
+GeaFlow设计论文参考：[GeaFlow: A Graph Extended and Accelerated Dataflow System](https://dl.acm.org/doi/abs/10.1145/3589771)
+
+## 快速上手
+
+1. 准备Git、JDK8、Maven、Docker环境。
+2. 下载源码：`git clone https://github.com/TuGraph-family/tugraph-analytics`
+3. 项目构建：`mvn clean install -DskipTests`
+4. 测试任务：`./bin/gql_submit.sh --gql geaflow/geaflow-examples/gql/loop_detection.sql`
+3. 构建镜像：`./build.sh --all`
+4. 启动容器：`docker run -d --name geaflow-console -p 8888:8888 geaflow-console:0.1`
+
+更多详细内容请参考：[快速上手文档](3.quick_start/1.quick_start.md)。
+
+## 开发手册
+
+GeaFlow支持DSL和API两套编程接口，您既可以通过GeaFlow提供的类SQL扩展语言SQL+ISO/GQL进行流图计算作业的开发，也可以通过GeaFlow的高阶API编程接口通过Java语言进行应用开发。
+* DSL应用开发：[DSL开发文档](5.application-development/2.dsl/1.overview.md)
+* API应用开发：[API开发文档](5.application-development/1.api/1.overview.md)
+
+## 实时能力
+
+相比传统的流式计算引擎比如Flink、Storm这些以表为模型的实时处理系统而言，GeaFlow以图为数据模型，在处理Join关系运算，尤其是复杂多跳的关系运算如3跳以上的Join、复杂环路查找上具备极大的性能优势。
+
+[![total_time](../../static/img/vs_join_total_time_cn.jpg)](reference/vs_join.md)
+
+## 合作伙伴
+|                  |                  |                  |
+|------------------|------------------|------------------|
+| [![HUST](../../static/img/partners/hust.png)](https://github.com/CGCL-codes/YiTu) | [![FU](../../static/img/partners/fu.png)](http://kw.fudan.edu.cn/) | ![ZJU](../../static/img/partners/zju.png) |
+| [![WhaleOps](../../static/img/partners/whaleops.png)](http://www.whaleops.com/) | [![OceanBase](../../static/img/partners/oceanbase.png)](https://github.com/oceanbase/oceanbase) | [![SecretFlow](../../static/img/partners/secretflow.png)](https://github.com/secretflow/secretflow) |
+
+
+