Skip to content

Commit 655c3fd

Browse files
authored
BREAKING CHANGE: graduate as TLP & refactor a string of docs (#447)
* docs: AGENTS.md, README.md, contribution.md Restructure and clarify repository documentation. AGENTS.md was rewritten and condensed into a practical agent/dev guide with development commands, prerequisites (Hugo Extended, Node.js v16+), content/structure overview, CI/CD notes, and troubleshooting tips. README.md was replaced with a bilingual (ZH/EN) homepage including a 3-step quickstart, repo layout, common commands, contributing requirements, contact info, and license. contribution.md was expanded with a PR checklist and clearer contribution steps (fork/branch/PR with screenshots). These changes improve onboarding and contribution workflows for the docs site. * Update README.md * server: update docs and configs for HugeGraph 1.7.0 Bump documentation site version and update docs/configs to reflect HugeGraph 1.7.0 changes: update config.toml version to 1.7; add Version Change notices for Auth REST API in CN/EN; revise HugeGraph-Server quickstart (docker images, download/toolchain URLs) and add deprecation warnings for removed legacy backends (MySQL, PostgreSQL, Cassandra, ScyllaDB) in favor of 1.7 backends (RocksDB, HStore, HBase, Memory). Update default rest-server config docs: increase batch.max_* defaults, raise batch.max_write_ratio, set exception.allow_trace true, add log.slow_query_threshold, and add K8s / PD/Meta / Arthas configuration option sections. * toolchain: add Spark connector and update Hubble/Tools Add HugeGraph-Spark-Connector quick start docs (English and Chinese). Add a Configuration section to HugeGraph-Hubble docs (server settings and Gremlin query limits) in both languages. Update hugegraph-tools docs (EN/CN) to document new graph commands (graph-create, graph-clone, graph-drop), authentication backup/restore (auth-backup, auth-restore), --thread-num option for relevant commands, and minor heading/usage adjustments. * AI: Add HugeGraph-AI docs and quickstart updates Add comprehensive HugeGraph-AI documentation and update quickstart content. New files added (Chinese & English): config-reference.md (full configuration reference), hugegraph-ml.md (HugeGraph-ML overview, algorithms and examples), and rest-api.md (REST API reference including RAG and Text2Gremlin endpoints). Updated pages: _index.md (feature list and v1.5.0 highlights such as Text2Gremlin, multi-model vectors, bilingual prompts, LiteLLM support, enhanced rerankers), hugegraph-llm.md (LLM provider/LiteLLM, reranker and Text2Gremlin usage), and quick_start.md (language switching / bilingual prompt guide). Also tightened environment requirements (Python 3.10+, uv 0.7+, HugeGraph 1.5+) and updated ML algorithm count/details to 21. These changes expand docs for deploying and integrating LLM, Text2Gremlin, ML workflows and REST APIs. * Revise and expand Computer config docs (CN/EN) Rewrite and restructure the Computer configuration documentation in both Chinese and English. The changes replace the old flat option tables with organized sections (Basics, Algorithm, Input, Snapshot/Storage, Worker/Master, I/O/Output, Network/Transport, Storage, BSP, Performance, System-managed, K8s Operator, KubeDriver and CRD). Added clear default-value semantics, examples for local and MinIO snapshots, notes about system-managed options (do not modify), and more explanatory text for many options. Also updated related CRD/KubeDriver fields formatting and clarified operator environment variable mapping. Minor related updates applied to the quickstart computing hugegraph-computer page. * BREAKING CHANGE: update docs links and Chinese content Change repository links from incubator to apache/hugegraph and apache/hugegraph-doc in config and many docs; update Chinese homepage and docs with refreshed wording (add AI/LLM, features blocks, revised introductions and CTAs); adjust multiple changelog weights and fix numerous internal/repo links and examples to reflect project rename and content improvements. * Add API descriptions and update quickstart links Add description frontmatter to many REST API docs (Chinese and English) to provide concise summaries for each API page. Update quickstart index pages (computing, hugegraph‑ai, toolchain) to recommend DeepWiki with direct links and add GitHub access links. Revise CN FAQ backend storage guidance to describe single-node (RocksDB) vs distributed (HStore) deployment, recommend selection by scale, and note deprecation of Cassandra/HBase/MySQL in later versions. * Update config docs titles and layout Revise configuration documentation for both CN and EN sites: update page titles and linkTitle fields for config guide and options, enrich the config index pages with Server configuration overview and links (including auth/HTTPS), and move/rename the Computer config page from config/ to quickstart/computing/ with updated title, linkTitle and weight. Also adjust wording about distributed deployment scale (changed from "100GB+" to "< 1000TB") in FAQ and introduction pages for both languages. * Update config docs: titles and reformat sections Rename config guide and reference titles (English & Chinese) to "Server Startup Guide" and "Server Complete Configuration Manual"; reorganize config-option pages by converting optional/config blocks (K8s, Arthas, RPC server, HBase, Cassandra/ScyllaDB, MySQL/PostgreSQL) into collapsible <details> sections and group deprecated backends under a "≤ 1.5 Version Config (Legacy)" section. Also adjust index bullets ordering/labels. These changes improve readability and clearly mark legacy backend configs.
1 parent fa6ee62 commit 655c3fd

File tree

123 files changed

+4370
-747
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+4370
-747
lines changed

config.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ theme = "default"
4545
name = "GitHub"
4646
weight = -99
4747
pre = "<i class='fab fa-github pr-2'></i>"
48-
url = "https://github.com/apache/incubator-hugegraph"
48+
url = "https://github.com/apache/hugegraph"
4949
[[menu.main]]
5050
name ="Download"
5151
weight = -98
@@ -159,9 +159,9 @@ version = "1.7"
159159
url_latest_version = "https://example.com"
160160

161161
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
162-
github_repo = "https://github.com/apache/incubator-hugegraph-doc"
162+
github_repo = "https://github.com/apache/hugegraph-doc"
163163
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
164-
github_project_repo = "https://github.com/apache/incubator-hugegraph"
164+
github_project_repo = "https://github.com/apache/hugegraph"
165165

166166
# Specify a value here if your content directory is not in your repo's root directory
167167
# github_subdir = ""

content/cn/_index.html

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,23 @@
1111
<h1 ><span style="font-size:50px;font-weight:bold">Apache</span>
1212
<span style="font-size:50px;font-weight:bold">HugeGraph</span>
1313
</h1>
14-
<p><span style="font-size:20px; float:contour">&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;
15-
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;Incubating</span><br/></p>
1614

1715
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
1816
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
1917
</a>
2018
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/apache/hugegraph">
2119
Download <i class="fab fa-github ml-2 "></i>
2220
</a>
23-
<p class="lead mt-5">HugeGraph是一款易用、高效、通用的图数据库</p>
24-
<p>实现了Apache TinkerPop3框架、兼容Gremlin查询语言</p>
21+
<p class="lead mt-5">HugeGraph 是一款全栈式图数据库系统</p>
22+
<p>支持从数据存储、实时查询到离线分析的完整图数据处理能力,同时支持 Gremlin 和 Cypher 查询语言</p>
2523
{{< blocks/link-down color="info" >}}
2624
</div>
2725
{{< /blocks/cover >}}
2826

2927

3028
{{% blocks/lead color="primary" %}}
31-
<p>HugeGraph支持百亿以上的顶点(Vertex)和边(Edge)快速导入,毫秒级的关联查询能力,并可与Hadoop、Spark等</p>
32-
<p>大数据平台集成以进行离线分析,主要应用场景包括关联分析、欺诈检测和知识图谱等</p>
29+
<p>HugeGraph 支持百亿级图数据高速导入与毫秒级实时查询,可与 Spark、Flink 等大数据平台深度集成。</p>
30+
<p>在 AI 时代,通过与大语言模型 (LLM) 结合,为智能问答、推荐系统、风控反欺诈、知识图谱等场景提供强大的图计算能力</p>
3331
{{% /blocks/lead %}}
3432

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

5149

50+
{{% blocks/feature icon="fa-brain" title="智能化" %}}
51+
集成LLM实现GraphRAG智能问答、自动化知识图谱构建,内置20+图机器学习算法,轻松构建AI驱动的图应用。
52+
{{% /blocks/feature %}}
53+
54+
55+
{{% blocks/feature icon="fa-expand-arrows-alt" title="可扩展" %}}
56+
支持水平扩容和分布式部署,从单机到PB级集群无缝迁移,提供多种存储引擎适配,满足不同规模和性能需求。
57+
{{% /blocks/feature %}}
58+
59+
60+
{{% blocks/feature icon="fa-puzzle-piece" title="开放生态" %}}
61+
遵循Apache TinkerPop标准,提供Java、Python、Go等多语言客户端,兼容主流大数据平台,社区活跃持续演进。
62+
{{% /blocks/feature %}}
63+
64+
5265
{{< /blocks/section >}}
5366

5467

5568
{{< blocks/section color="blue-deep">}}
5669
<div class="col">
57-
<h1 class="text-center">第一个 Apache 图数据库项目</h1>
70+
<h1 class="text-center">首个 Apache 基金会的顶级图项目</h1>
5871
</div>
5972

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

6477
{{< blocks/section >}}
6578
{{% blocks/feature icon="far fa-tools" title="使用易用的**工具链**" %}}
66-
可从[此](https://github.com/apache/incubator-hugegraph-toolchain)获取图数据导入工具, 可视化界面以及备份还原迁移工具, 欢迎使用
79+
可从[此](https://github.com/apache/hugegraph-toolchain)获取图数据导入工具, 可视化界面以及备份还原迁移工具, 欢迎使用
6780
{{% /blocks/feature %}}
6881

6982

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

8699
<div class="col-12">
87-
<h1 class="text-center">欢迎大家参与 HugeGraph 的任何贡献</h1>
100+
<h1 class="text-center">欢迎大家给 HugeGraph 添砖加瓦</h1>
88101
</div>
89102

90103
{{< /blocks/section >}}

content/cn/docs/_index.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,52 @@ menu:
77
weight: 20
88
---
99

10-
欢迎阅读HugeGraph文档
10+
## Apache HugeGraph 文档
11+
12+
Apache HugeGraph 是一套完整的图数据库生态系统,支持 OLTP 实时查询、OLAP 离线分析和 AI 智能应用。
13+
14+
### 按场景快速导航
15+
16+
| 我想要... | 从这里开始 |
17+
|----------|-----------|
18+
| **运行图查询** (OLTP) | [HugeGraph Server 快速开始](quickstart/hugegraph-server/hugegraph-server) |
19+
| **大规模图计算** (OLAP) | [图计算引擎](quickstart/hugegraph-computer/hugegraph-computer) |
20+
| **构建 AI/RAG 应用** | [HugeGraph-AI](quickstart/hugegraph-ai) |
21+
| **批量导入数据** | [HugeGraph Loader](quickstart/hugegraph-loader) |
22+
| **可视化管理图** | [Hubble Web UI](quickstart/hugegraph-hubble) |
23+
24+
### 生态系统一览
25+
26+
```
27+
┌─────────────────────────────────────────────────────────────────┐
28+
│ Apache HugeGraph 生态 │
29+
├─────────────────────────────────────────────────────────────────┤
30+
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
31+
│ │ HugeGraph │ │ HugeGraph │ │ HugeGraph-AI │ │
32+
│ │ Server │ │ Computer │ │ (GraphRAG/ML/Python) │ │
33+
│ │ (OLTP) │ │ (OLAP) │ │ │ │
34+
│ └─────────────┘ └─────────────┘ └─────────────────────────┘ │
35+
│ │ │ │ │
36+
│ ┌──────┴───────────────┴────────────────────┴──────────────┐ │
37+
│ │ HugeGraph Toolchain │ │
38+
│ │ Hubble (UI) | Loader | Client (Java/Go/Python) | Tools │ │
39+
│ └───────────────────────────────────────────────────────────┘ │
40+
└─────────────────────────────────────────────────────────────────┘
41+
```
42+
43+
### 核心组件
44+
45+
- **HugeGraph Server** - 图数据库核心,REST API + Gremlin + Cypher 支持
46+
- **HugeGraph Toolchain** - 客户端 SDK、数据导入、可视化、运维工具
47+
- **HugeGraph Computer** - 分布式图计算 (Vermeer 高性能内存版 / Computer 海量存储外存版)
48+
- **HugeGraph-AI** - GraphRAG、知识图谱构建、20+ 图机器学习算法
49+
50+
### 部署模式
51+
52+
| 模式 | 适用场景 | 数据规模 |
53+
|-----|---------|---------|
54+
| **单机版** | 极速稳定、存算一体 | < 1000TB |
55+
| **分布式** | 海量存储、存算分离 | >= 1000TB |
56+
| **Docker** | 快速体验 | 任意 |
57+
58+
[📖 详细介绍](introduction/)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph 0.10 Release Notes"
33
linkTitle: "Release-0.10.4"
44
draft: true
5-
weight: 14
5+
weight: 15
66
---
77

88
### API & Client

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "HugeGraph 0.12 Release Notes"
33
linkTitle: "Release-0.12.0"
4-
weight: 1
4+
weight: 11
55
---
66

77
### API & Client

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph 0.2 Release Notes"
33
linkTitle: "Release-0.2.4"
44
draft: true
5-
weight: 23
5+
weight: 33
66
---
77

88
### API & Java Client

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph 0.2.4 Release Notes"
33
linkTitle: "Release-0.2.4"
44
draft: true
5-
weight: 22
5+
weight: 31
66
---
77

88
### API & Java Client

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph 0.3.3 Release Notes"
33
linkTitle: "Release-0.3.3"
44
draft: true
5-
weight: 21
5+
weight: 29
66
---
77

88
### API & Java Client

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph 0.4.4 Release Notes"
33
linkTitle: "Release-0.4.4"
44
draft: true
5-
weight: 20
5+
weight: 27
66
---
77

88
### API & Java Client

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph 0.5 Release Notes"
33
linkTitle: "Release-0.5.6"
44
draft: true
5-
weight: 19
5+
weight: 25
66
---
77

88
### API & Java Client

0 commit comments

Comments
 (0)