BREAKING CHANGE: graduate as TLP & refactor a string of docs #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

imbajin merged 11 commits into master from update-doc

Feb 2, 2026

config.toml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -45,7 +45,7 @@ theme = "default"
  
        name = "GitHub"

        weight = -99

        pre = "<i class='fab fa-github pr-2'></i>"

        url = "https://github.com/apache/incubator-hugegraph"

        url = "https://github.com/apache/hugegraph"

      [[menu.main]]

        name ="Download"

        weight = -98

    @@ -159,9 +159,9 @@ version = "1.7"
  
    url_latest_version = "https://example.com"

    # Repository configuration (URLs for in-page links to opening issues and suggesting changes)

    github_repo = "https://github.com/apache/incubator-hugegraph-doc"

    github_repo = "https://github.com/apache/hugegraph-doc"

    # An optional link to a related project repo. For example, the sibling repository where your product code lives.

    github_project_repo = "https://github.com/apache/incubator-hugegraph"

    github_project_repo = "https://github.com/apache/hugegraph"

    # Specify a value here if your content directory is not in your repo's root directory

    # github_subdir = ""

content/cn/_index.html

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -11,25 +11,23 @@
  
    	<h1 ><span style="font-size:50px;font-weight:bold">Apache</span>

    		<span style="font-size:50px;font-weight:bold">HugeGraph</span>

    	</h1>

    	<p><span style="font-size:20px; float:contour">&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;

    		&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;Incubating</span><br/></p>

    	<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">

    		Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>

    	</a>

    	<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/apache/hugegraph">

    		Download <i class="fab fa-github ml-2 "></i>

    	</a>

    	<p class="lead mt-5">HugeGraph是一款易用、高效、通用的图数据库</p>

    	<p>实现了Apache TinkerPop3框架、兼容Gremlin查询语言。</p>

    	<p class="lead mt-5">HugeGraph 是一款全栈式图数据库系统</p>

    	<p>支持从数据存储、实时查询到离线分析的完整图数据处理能力，同时支持 Gremlin 和 Cypher 查询语言。</p>

    	{{< blocks/link-down color="info" >}}

    </div>

    {{< /blocks/cover >}}

    {{% blocks/lead color="primary" %}}

    <p>HugeGraph支持百亿以上的顶点(Vertex)和边(Edge)快速导入，毫秒级的关联查询能力，并可与Hadoop、Spark等</p>

    <p>大数据平台集成以进行离线分析，主要应用场景包括关联分析、欺诈检测和知识图谱等。</p>

    <p>HugeGraph 支持百亿级图数据高速导入与毫秒级实时查询，可与 Spark、Flink 等大数据平台深度集成。</p>

    <p>在 AI 时代，通过与大语言模型 (LLM) 结合，为智能问答、推荐系统、风控反欺诈、知识图谱等场景提供强大的图计算能力。</p>

    {{% /blocks/lead %}}

    {{< blocks/section color="dark" >}}

    @@ -49,12 +47,27 @@ <h1 ><span style="font-size:50px;font-weight:bold">Apache</span>
  
    {{% /blocks/feature %}}

    {{% blocks/feature icon="fa-brain" title="智能化" %}}

    集成LLM实现GraphRAG智能问答、自动化知识图谱构建，内置20+图机器学习算法，轻松构建AI驱动的图应用。

    {{% /blocks/feature %}}

    {{% blocks/feature icon="fa-expand-arrows-alt" title="可扩展" %}}

    支持水平扩容和分布式部署，从单机到PB级集群无缝迁移，提供多种存储引擎适配，满足不同规模和性能需求。

    {{% /blocks/feature %}}

    {{% blocks/feature icon="fa-puzzle-piece" title="开放生态" %}}

    遵循Apache TinkerPop标准，提供Java、Python、Go等多语言客户端，兼容主流大数据平台，社区活跃持续演进。

    {{% /blocks/feature %}}

    {{< /blocks/section >}}

    {{< blocks/section color="blue-deep">}}

    <div class="col">

    <h1 class="text-center">第一个 Apache 图数据库项目</h1>

    <h1 class="text-center">首个 Apache 基金会的顶级图项目</h1>

    </div>

    {{< /blocks/section >}}

    @@ -63,7 +76,7 @@ <h1 class="text-center">第一个 Apache 图数据库项目</h1>
  
    {{< blocks/section >}}

    {{% blocks/feature icon="far fa-tools" title="使用易用的**工具链**" %}}

    可从[此](https://github.com/apache/incubator-hugegraph-toolchain)获取图数据导入工具, 可视化界面以及备份还原迁移工具, 欢迎使用

    可从[此](https://github.com/apache/hugegraph-toolchain)获取图数据导入工具, 可视化界面以及备份还原迁移工具, 欢迎使用

    {{% /blocks/feature %}}

    @@ -84,7 +97,7 @@ <h1 class="text-center">第一个 Apache 图数据库项目</h1>
  
    {{< blocks/section color="blue-light">}}

    <div class="col-12">

    <h1 class="text-center">欢迎大家参与 HugeGraph 的任何贡献</h1>

    <h1 class="text-center">欢迎大家给 HugeGraph 添砖加瓦</h1>

    </div>

    {{< /blocks/section >}}

content/cn/docs/_index.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,4 +7,52 @@ menu: @@
         weight: 20
     ---
-    欢迎阅读HugeGraph文档
+    ## Apache HugeGraph 文档
+    Apache HugeGraph 是一套完整的图数据库生态系统，支持 OLTP 实时查询、OLAP 离线分析和 AI 智能应用。
+    ### 按场景快速导航
+    | 我想要... | 从这里开始 |
+    |----------|-----------|
+    | **运行图查询** (OLTP) | [HugeGraph Server 快速开始](quickstart/hugegraph-server/hugegraph-server) |
+    | **大规模图计算** (OLAP) | [图计算引擎](quickstart/hugegraph-computer/hugegraph-computer) |
+    | **构建 AI/RAG 应用** | [HugeGraph-AI](quickstart/hugegraph-ai) |
+    | **批量导入数据** | [HugeGraph Loader](quickstart/hugegraph-loader) |
+    | **可视化管理图** | [Hubble Web UI](quickstart/hugegraph-hubble) |
+    ### 生态系统一览
+    ```
+    ┌─────────────────────────────────────────────────────────────────┐
+    │                    Apache HugeGraph 生态                         │
+    ├─────────────────────────────────────────────────────────────────┤
+    │  ┌─────────────┐  ┌─────────────┐  ┌─────────────────────────┐  │
+    │  │ HugeGraph   │  │ HugeGraph   │  │ HugeGraph-AI            │  │
+    │  │ Server      │  │ Computer    │  │ (GraphRAG/ML/Python)    │  │
+    │  │ (OLTP)      │  │ (OLAP)      │  │                         │  │
+    │  └─────────────┘  └─────────────┘  └─────────────────────────┘  │
+    │         │               │                    │                   │
+    │  ┌──────┴───────────────┴────────────────────┴──────────────┐   │
+    │  │              HugeGraph Toolchain                          │   │
+    │  │  Hubble (UI) | Loader | Client (Java/Go/Python) | Tools   │   │
+    │  └───────────────────────────────────────────────────────────┘   │
+    └─────────────────────────────────────────────────────────────────┘
+    ```
+    ### 核心组件
+    - **HugeGraph Server** - 图数据库核心，REST API + Gremlin + Cypher 支持
+    - **HugeGraph Toolchain** - 客户端 SDK、数据导入、可视化、运维工具
+    - **HugeGraph Computer** - 分布式图计算 (Vermeer 高性能内存版 / Computer 海量存储外存版)
+    - **HugeGraph-AI** - GraphRAG、知识图谱构建、20+ 图机器学习算法
+    ### 部署模式
+    | 模式 | 适用场景 | 数据规模 |
+    |-----|---------|---------|
+    | **单机版** | 极速稳定、存算一体 | < 1000TB |
+    | **分布式** | 海量存储、存算分离 | >= 1000TB |
+    | **Docker** | 快速体验 | 任意 |
+    [📖 详细介绍](introduction/)

content/cn/docs/changelog/hugegraph-0.10.4-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.10 Release Notes"
     linkTitle: "Release-0.10.4"
     draft: true
-    weight: 14
+    weight: 15
     ---
     ### API & Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     ---
     title: "HugeGraph 0.12 Release Notes"
     linkTitle: "Release-0.12.0"
-    weight: 1
+    weight: 11
     ---
     ### API & Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.2-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.2 Release Notes"
     linkTitle: "Release-0.2.4"
     draft: true
-    weight: 23
+    weight: 33
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.2.4-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.2.4 Release Notes"
     linkTitle: "Release-0.2.4"
     draft: true
-    weight: 22
+    weight: 31
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.3.3-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.3.3 Release Notes"
     linkTitle: "Release-0.3.3"
     draft: true
-    weight: 21
+    weight: 29
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.4.4-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.4.4 Release Notes"
     linkTitle: "Release-0.4.4"
     draft: true
-    weight: 20
+    weight: 27
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.5.6-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.5 Release Notes"
     linkTitle: "Release-0.5.6"
     draft: true
-    weight: 19
+    weight: 25
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.6.1-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.6 Release Notes"
     linkTitle: "Release-0.6.1"
     draft: true
-    weight: 18
+    weight: 23
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.7.4-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.7 Release Notes"
     linkTitle: "Release-0.7.4"
     draft: true
-    weight: 17
+    weight: 21
     ---
     ### API & Java Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.8.0-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.8 Release Notes"
     linkTitle: "Release-0.8.0"
     draft: true
-    weight: 16
+    weight: 19
     ---
     ### API & Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-0.9.2-release-notes.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     title: "HugeGraph 0.9 Release Notes"
     linkTitle: "Release-0.9.2"
     draft: true
-    weight: 15
+    weight: 17
     ---
     ### API & Client
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     ---
     title: "HugeGraph 1.0.0 Release Notes"
     linkTitle: "Release-1.0.0"
-    weight: 2
+    weight: 9
     ---
     ### OLTP API & Client 更新
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-1.2.0-release-notes.md

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     ---
     title: "HugeGraph 1.2.0 Release Notes"
     linkTitle: "Release-1.2.0"
-    weight: 3
+    weight: 7
     ---
     ### Java version statement
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-1.3.0-release-notes.md

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     ---
     title: "HugeGraph 1.3.0 Release Notes"
     linkTitle: "Release-1.3.0"
-    weight: 4
+    weight: 5
     ---
     ### 运行环境/版本说明
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-1.5.0-release-notes.md

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     ---
     title: "HugeGraph 1.5.0 Release Notes"
     linkTitle: "Release-1.5.0"
-    weight: 5
+    weight: 3
     ---
     > WIP: This doc is under construction, please wait for the final version (BETA)
@@ Expand Down @@

content/cn/docs/changelog/hugegraph-1.7.0-release-notes.md

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     ---
     title: "HugeGraph 1.7.0 Release Notes"
     linkTitle: "Release-1.7.0"
-    weight: 7
+    weight: 1
     ---
     > WIP: This doc is under construction, please wait for the final version (BETA)
@@ Expand Down @@

content/cn/docs/clients/gremlin-console.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -43,7 +43,7 @@ gremlin> @@
     > 这里的 `--` 会被 getopts 解析为最后一个 option，这样后面的 options 就可以传入 Gremlin-Console 进行处理了。`-i` 代表 `Execute the specified script and leave the console open on completion`，更多的选项可以参考 Gremlin-Console 的[源代码](https://github.com/apache/tinkerpop/blob/3.5.1/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/Console.groovy#L483)。
-    其中 [`example.groovy`](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy) 是 scripts 目录下的一个示例脚本，该脚本插入了一些数据，并在最后查询图中顶点和边的数量。
+    其中 [`example.groovy`](https://github.com/apache/hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy) 是 scripts 目录下的一个示例脚本，该脚本插入了一些数据，并在最后查询图中顶点和边的数量。
     此时还可以继续输入 Gremlin 语句对图进行操作：
@@ Expand Down @@

content/cn/docs/clients/restful-api/_index.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,7 @@ weight: 1 @@
     > - HugeGraph 1.7.0+ 引入了图空间功能，API 路径格式为：`/graphspaces/{graphspace}/graphs/{graph}`
     > - HugeGraph 1.5.x 及之前版本使用旧路径：`/graphs/{graph}`, 以及创建/克隆图的 api 使用 text/plain 作为 Content-Type, 1.7.0 及之后使用 json
     > - 默认图空间名称为 `DEFAULT`,可直接使用
-    > - 旧版本 doc 参考：[HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
+    > - 旧版本 doc 参考：[HugeGraph 1.5.x RESTful API](https://github.com/apache/hugegraph-doc/tree/release-1.5.0)
     除了下方的文档，你还可以通过 `localhost:8080/swagger-ui/index.html` 访问 `swagger-ui` 以查看 `RESTful API`。[示例可以参考此处](/cn/docs/quickstart/hugegraph/hugegraph-server#swaggerui-example)
@@ Expand Down @@

content/cn/docs/clients/restful-api/auth.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,11 +2,12 @@ @@
     title: "Authentication API"
     linkTitle: "Authentication"
     weight: 16
+    description: "Authentication（认证鉴权）REST 接口:管理用户、角色、权限和访问控制,实现细粒度的图数据安全机制。"
     ---
     > **版本变更说明**:
     > - 1.7.0+: Auth API 路径使用 GraphSpace 格式，如 `/graphspaces/DEFAULT/auth/users`，且 group/target 等 id 格式与 name 一致（如 `admin`）
-    > - 1.5.x 及更早: Auth API 路径包含 graph 名称，group/target 等 id 格式类似 `-69:grant`。参考 [HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
+    > - 1.5.x 及更早: Auth API 路径包含 graph 名称，group/target 等 id 格式类似 `-69:grant`。参考 [HugeGraph 1.5.x RESTful API](https://github.com/apache/hugegraph-doc/tree/release-1.5.0)
     ### 10.1 用户认证与权限控制
@@ Expand All / @@ -26,7 +27,7 @@ city: Beijing}) @@
     ##### 接口说明：
     用户认证与权限控制接口包括 5 类：UserAPI、GroupAPI、TargetAPI、BelongAPI、AccessAPI。
-    **注意**: 1.5.0 及之前，group/target 等 id 的格式类似 -69:grant，1.7.0 及之后，id 和 name 一致，如 admin [HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
+    **注意**: 1.5.0 及之前，group/target 等 id 的格式类似 -69:grant，1.7.0 及之后，id 和 name 一致，如 admin [HugeGraph 1.5.x RESTful API](https://github.com/apache/hugegraph-doc/tree/release-1.5.0)
     ### 10.2 用户（User）API
     用户接口包括：创建用户，删除用户，修改用户，和查询用户相关信息接口。
@@ Expand Down @@

content/cn/docs/clients/restful-api/cypher.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     title: "Cypher API"
     linkTitle: "Cypher"
     weight: 15
+    description: "Cypher（图查询语言）REST 接口:通过 HTTP 接口执行 OpenCypher 声明式图查询语言。"
     ---
     ### 9.1 Cypher
@@ Expand Down @@

content/cn/docs/clients/restful-api/edge.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     title: "Edge API"
     linkTitle: "Edge"
     weight: 8
+    description: "Edge（边）REST 接口:创建、查询、更新和删除顶点之间的关系数据,支持批量操作和方向查询。"
     ---
     ### 2.2 Edge
@@ Expand Down @@

content/cn/docs/clients/restful-api/edgelabel.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     title: "EdgeLabel API"
     linkTitle: "EdgeLabel"
     weight: 4
+    description: "EdgeLabel（边标签）REST 接口:定义边类型、源顶点和目标顶点的关系约束,构建图的连接规则。"
     ---
     ### 1.4 EdgeLabel
@@ Expand Down @@

content/cn/docs/clients/restful-api/graphs.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     title: "Graphs API"
     linkTitle: "Graphs"
     weight: 12
+    description: "Graphs（图管理）REST 接口:管理图实例的生命周期,包括创建、查询、克隆、清空和删除图数据库。"
     ---
     ### 6.1 Graphs
@@ Expand Down Expand Up @@
     - 非鉴权模式：`"gremlin.graph": "org.apache.hugegraph.HugeFactory"`
     **注意**！！
-. 在 1.7.0 版本中，动态创建图会导致 NPE 错误。该问题已在 [PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912) 中修复。当前 master 版本和 1.7.0 之前的版本不受此问题影响。
+. 在 1.7.0 版本中，动态创建图会导致 NPE 错误。该问题已在 [PR#2912](https://github.com/apache/hugegraph/pull/2912) 中修复。当前 master 版本和 1.7.0 之前的版本不受此问题影响。
 . 1.7.0 及之前版本，如果 backend 是 hstore，必须在请求体加上 "task.scheduler_type": "distributed"。同时请确保 HugeGraph-Server 已正确配置 PD，参见 [HStore 配置](/cn/docs/quickstart/hugegraph/hugegraph-server/#511-分布式存储hstore)。
     **RocksDB 示例：**
@@ Expand Down @@

content/cn/docs/clients/restful-api/gremlin.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     title: "Gremlin API"
     linkTitle: "Gremlin"
     weight: 14
+    description: "Gremlin（图查询语言）REST 接口:通过 HTTP 接口执行 Gremlin 图遍历查询语言脚本。"
     ---
     ### 8.1 Gremlin
@@ Expand Down @@

content/cn/docs/clients/restful-api/indexlabel.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     title: "IndexLabel API"
     linkTitle: "IndexLabel"
     weight: 5
+    description: "IndexLabel（索引标签）REST 接口:为顶点和边的属性创建索引,加速基于属性的查询和过滤操作。"
     ---
     ### 1.5 IndexLabel
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BREAKING CHANGE: graduate as TLP & refactor a string of docs #447

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!