Skip to content

doc: update storage scale guidance to <4TB & validate url in ci #448

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.

Sign up for GitHub

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 16 commits into from
Feb 3, 2026
Merged

doc: update storage scale guidance to <4TB & validate url in ci #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9d20ef8
docs: AGENTS.md, README.md, contribution.md
imbajin Jan 31, 2026
b1a48cc
Update README.md
imbajin Jan 31, 2026
b12fe33
server: update docs and configs for HugeGraph 1.7.0
imbajin Jan 31, 2026
0352d0a
toolchain: add Spark connector and update Hubble/Tools
imbajin Jan 31, 2026
708a6df
AI: Add HugeGraph-AI docs and quickstart updates
imbajin Jan 31, 2026
41790b0
Merge branch 'master' into update-doc
imbajin Jan 31, 2026
06b7a95
Revise and expand Computer config docs (CN/EN)
imbajin Feb 1, 2026
610d90a
BREAKING CHANGE: update docs links and Chinese content
imbajin Feb 2, 2026
579df7a
Add API descriptions and update quickstart links
imbajin Feb 2, 2026
c93a6e1
Update config docs titles and layout
imbajin Feb 2, 2026
c80b604
Update config docs: titles and reformat sections
imbajin Feb 2, 2026
7910d2e
Merge branch 'master' into update-doc
imbajin Feb 2, 2026
ee176b5
doc: update storage scale guidance to <4TB
imbajin Feb 2, 2026
b7582d9
Add link validation script to CI
imbajin Feb 3, 2026
d72e871
Normalize documentation links and validator
imbajin Feb 3, 2026
27bb7a4
Rename api-preformance to api-performance
imbajin Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/hugo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ jobs:
restore-keys: |
${{ runner.os }}-hugomod-

- name: Check Links
run: bash dist/validate-links.sh

- name: Build Site (minify)
run: npm i && hugo --minify

Expand Down
7 changes: 0 additions & 7 deletions DISCLAIMER
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions content/cn/docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@

## Performance
* [HugeGraph Benchmark Performance](performance/hugegraph-benchmark-0.5.6.md)
* [HugeGraph API Performance-Outdated](content/cn/docs/performance/api-preformance/_index.md)
* [v0.5.6 Stand-alone(RocksDB)](content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-RocksDB.md)
* [v0.5.6 Cluster(Cassandra)](content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-Cassandra.md)
* [v0.4.4](content/cn/docs/performance/api-preformance/hugegraph-api-0.4.4.md)
* [v0.2](content/cn/docs/performance/api-preformance/hugegraph-api-0.2.md)
* [HugeGraph API Performance-Outdated](content/cn/docs/performance/api-performance/_index.md)
* [v0.5.6 Stand-alone(RocksDB)](content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb.md)
* [v0.5.6 Cluster(Cassandra)](content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra.md)
* [v0.4.4](content/cn/docs/performance/api-performance/hugegraph-api-0.4.4.md)
* [v0.2](content/cn/docs/performance/api-performance/hugegraph-api-0.2.md)
* [HugeGraph-Loader Performance](performance/hugegraph-loader-performance.md)

## ChangeLogs
Expand Down
4 changes: 2 additions & 2 deletions content/cn/docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Apache HugeGraph 是一套完整的图数据库生态系统，支持 OLTP 实时

| 模式 | 适用场景 | 数据规模 |
|-----|---------|---------|
| **单机版** | 极速稳定、存算一体 | < 1000TB |
| **分布式** | 海量存储、存算分离 | >= 1000TB |
| **单机版** | 极速稳定、存算一体 | < 4TB |
| **分布式** | 海量存储、存算分离 | < 1000TB |
| **Docker** | 快速体验 | 任意 |

[📖 详细介绍](introduction/)
4 changes: 2 additions & 2 deletions content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 4

### 背景

在 [Quick Start](/docs/quickstart/hugegraph-server/) 部分已经介绍了使用**脚本**启停 HugeGraph-Server 的流程。下面以 Linux 平台为例，
在 [Quick Start](/docs/quickstart/hugegraph/hugegraph-server/) 部分已经介绍了使用**脚本**启停 HugeGraph-Server 的流程。下面以 Linux 平台为例，
介绍使用 **IntelliJ IDEA** 运行与调试 HugeGraph-Server 的流程。

本地启动的核心与**脚本启动**是一样的：
Expand Down Expand Up @@ -167,7 +167,7 @@ curl "http://localhost:8080/graphs/hugegraph/graph/vertices" | gunzip

##### 参考

1. [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph-server/)
1. [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph/hugegraph-server/)
2. [hugegraph-server 本地调试文档 (Win/Unix)](https://gist.github.com/imbajin/1661450f000cd62a67e46d4f1abfe82c)
3. ["package sun.misc does not exist" compilation error](https://youtrack.jetbrains.com/issue/IDEA-180033)
4. [Cannot compile: java: package sun.misc does not exist](https://youtrack.jetbrains.com/issue/IDEA-201168)
Expand Down
6 changes: 3 additions & 3 deletions content/cn/docs/download/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ weight: 2

#### 源码包

Please refer to [build from source](/docs/quickstart/hugegraph-server/).
Please refer to [build from source](/docs/quickstart/hugegraph/hugegraph-server/).

| Server | Toolchain | AI | Computer |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -53,7 +53,7 @@ Please refer to [build from source](/docs/quickstart/hugegraph-server/).

##### 源码包

Please refer to [build from source](/docs/quickstart/hugegraph-server/).
Please refer to [build from source](/docs/quickstart/hugegraph/hugegraph-server/).

| Server | Toolchain | AI | Computer |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -72,7 +72,7 @@ Please refer to [build from source](/docs/quickstart/hugegraph-server/).

##### 源码包

Please refer to [build from source](/docs/quickstart/hugegraph-server/).
Please refer to [build from source](/docs/quickstart/hugegraph/hugegraph-server/).

| Server | Toolchain | AI | Common |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/guides/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 6
- 如何选择后端存储? 选 RocksDB 还是分布式存储?

HugeGraph 支持多种部署模式，根据数据规模和场景选择：
- **单机模式**：Server + RocksDB，适合开发测试和中小规模数据（< 1TB）
- **单机模式**：Server + RocksDB，适合开发测试和中小规模数据（< 4TB）
- **分布式模式**：HugeGraph-PD + HugeGraph-Store (HStore)，支持水平扩展和高可用（< 1000TB 数据规模），适合生产环境和大规模图数据应用

注：Cassandra、HBase、MySQL 等后端仅在 HugeGraph <= 1.5 版本中可用，官方后续不再单独维护
Expand Down
6 changes: 3 additions & 3 deletions content/cn/docs/introduction/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ HugeGraph 支持多种部署模式，满足不同规模和场景的需求：

**单机模式 (Standalone)**
- Server + RocksDB 后端存储
- 适合开发测试和中小规模数据（< 1TB）
- 适合开发测试和中小规模数据（< 4TB）
- Docker 快速启动: `docker run hugegraph/hugegraph`
- 详见 [Server 快速开始](/cn/docs/quickstart/hugegraph-server/hugegraph-server)
- 详见 [Server 快速开始](/cn/docs/quickstart/hugegraph/hugegraph-server)

**分布式模式 (Distributed)**
- HugeGraph-PD: 元数据管理和集群调度
Expand All @@ -50,7 +50,7 @@ HugeGraph 支持多种部署模式，满足不同规模和场景的需求：

| 使用场景 | 推荐路径 |
|---------|---------|
| 快速体验 | [Docker 部署](/cn/docs/quickstart/hugegraph-server/hugegraph-server#docker) |
| 快速体验 | [Docker 部署](/cn/docs/quickstart/hugegraph/hugegraph-server#docker) |
| 构建 OLTP 应用 | Server → REST API / Gremlin / Cypher |
| 图分析 (OLAP) | [Vermeer](/cn/docs/quickstart/computing/hugegraph-computer) (推荐) 或 Computer |
| 构建 AI 应用 | [HugeGraph-AI](/cn/docs/quickstart/hugegraph-ai) (GraphRAG/知识图谱) |
Expand Down
4 changes: 2 additions & 2 deletions ...ocs/performance/api-preformance/_index.md → ...ocs/performance/api-performance/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ HugeGraph API性能测试主要测试HugeGraph-Server对RESTful API请求的并

HugeGraph的每个发布版本的RESTful API的性能测试情况可以参考：

- [v0.5.6 stand-alone](/docs/performance/api-preformance/hugegraph-api-0.5.6-rocksdb/)
- [v0.5.6 cluster](/docs/performance/api-preformance/hugegraph-api-0.5.6-cassandra/)
- [v0.5.6 stand-alone](/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb/)
- [v0.5.6 cluster](/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra/)

> 即将更新，敬请期待！

0 ...ance/api-preformance/hugegraph-api-0.2.md → ...ance/api-performance/hugegraph-api-0.2.md
View file
Open in desktop
File renamed without changes.
0 ...ce/api-preformance/hugegraph-api-0.4.4.md → ...ce/api-performance/hugegraph-api-0.4.4.md
View file
Open in desktop
File renamed without changes.
0 ...formance/hugegraph-api-0.5.6-Cassandra.md → ...formance/hugegraph-api-0.5.6-cassandra.md
View file
Open in desktop
File renamed without changes.
0 ...reformance/hugegraph-api-0.5.6-RocksDB.md → ...erformance/hugegraph-api-0.5.6-rocksdb.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/client/hugegraph-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ public class BatchExample {
#### 4.4 运行 Example

运行 Example 之前需要启动 Server,
启动过程见[HugeGraph-Server Quick Start](/cn/docs/quickstart/hugegraph-server)
启动过程见[HugeGraph-Server Quick Start](/cn/docs/quickstart/hugegraph/hugegraph-server)

#### 4.5 详细 API 说明

Expand Down
6 changes: 3 additions & 3 deletions content/cn/docs/quickstart/computing/hugegraph-computer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ mvn clean package -DskipTests

#### 3.1.3 启动 master 节点

> 您可以使用 `-c` 参数指定配置文件，更多 computer 配置请看：[Computer Config Options](/docs/config/config-computer#computer-config-options)
> 您可以使用 `-c` 参数指定配置文件，更多 computer 配置请看：[Computer Config Options](/docs/quickstart/computing/hugegraph-computer-config#computer-config-options)

```bash
cd hugegraph-computer
Expand Down Expand Up @@ -137,9 +137,9 @@ hugegraph-computer-operator-etcd-28lm67jxk5 1/1 Runnin

#### 3.2.5 提交作业

> 更多 computer crd spec 请看：[Computer CRD](/docs/config/config-computer#hugegraph-computer-crd)
> 更多 computer crd spec 请看：[Computer CRD](/docs/quickstart/computing/hugegraph-computer-config#hugegraph-computer-crd)
>
> 更多 Computer 配置请看：[Computer Config Options](/docs/config/config-computer#computer-config-options)
> 更多 Computer 配置请看：[Computer Config Options](/docs/quickstart/computing/hugegraph-computer-config#computer-config-options)

```yaml
cat <<EOF | kubectl apply --filename -
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-spark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ HugeGraph-Spark 是一个连接 HugeGraph 和 Spark GraphX 的工具，能够读

### 2 环境依赖

在使用 HugeGraph-Spark 前，需要依赖 HugeGraph Server 服务，下载和启动 Server 请参考 [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph-server)。另外，由于 HugeGraph-Spark 需要使用 Spark GraphX，所以还需要下载 spark，本文的示例使用的是 apache-spark-2.1.1。
在使用 HugeGraph-Spark 前，需要依赖 HugeGraph Server 服务，下载和启动 Server 请参考 [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph/hugegraph-server)。另外，由于 HugeGraph-Spark 需要使用 Spark GraphX，所以还需要下载 spark，本文的示例使用的是 apache-spark-2.1.1。

```
wget https://archive.apache.org/dist/spark/spark-2.1.1/spark-2.1.1-bin-hadoop2.7.tgz
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ HugeGraph-Studio是HugeGraph的前端展示工具，是基于Web的图形化IDE
- 图数据的展示
- 图数据的分析

> 注意：HugeGraph-Studio需要依赖HugeGraph-Server，在安装和使用HugeGraph-Studio之前，请通过jps命令检查HugeGraphServer服务是否已经启动，如果没有启动，请参考[HugeGraph-Server安装配置](/docs/quickstart/hugegraph-server)启动HugeGraphServer。
> 注意：HugeGraph-Studio需要依赖HugeGraph-Server，在安装和使用HugeGraph-Studio之前，请通过jps命令检查HugeGraphServer服务是否已经启动，如果没有启动，请参考[HugeGraph-Server安装配置](/docs/quickstart/hugegraph/hugegraph-server)启动HugeGraphServer。

### 2 安装和运行HugeGraph-Studio

Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,5 +136,5 @@ Caused by: org.rocksdb.RocksDBException: While lock file: rocksdb-data/data/m/LO
## Related Documentation

- [ToplingDB YAML Configuration Explained](/blog/2025/09/30/toplingdb-yaml-configuration-file/) – Understand each parameter in the config file
- [HugeGraph Configuration Guide](/docs/config/config-option/) – Reference for core HugeGraph settings
- [HugeGraph Configuration Guide](/docs/config/config-option) – Reference for core HugeGraph settings
- [ToplingDB GitHub Repository](https://github.com/topling/toplingdb) – Official docs and latest updates
Loading