diff --git a/.github/workflows/hugo.yml b/.github/workflows/hugo.yml index 01fbd69c8..17a1e1858 100644 --- a/.github/workflows/hugo.yml +++ b/.github/workflows/hugo.yml @@ -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 diff --git a/DISCLAIMER b/DISCLAIMER deleted file mode 100644 index be557e360..000000000 --- a/DISCLAIMER +++ /dev/null @@ -1,7 +0,0 @@ -Apache HugeGraph (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. - -Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, -and decision making process have stabilized in a manner consistent with other successful ASF projects. - -While incubation status is not necessarily a reflection of the completeness or stability of the code, -it does indicate that the project has yet to be fully endorsed by the ASF. diff --git a/content/cn/docs/SUMMARY.md b/content/cn/docs/SUMMARY.md index 784773b26..48f910d03 100644 --- a/content/cn/docs/SUMMARY.md +++ b/content/cn/docs/SUMMARY.md @@ -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 diff --git a/content/cn/docs/_index.md b/content/cn/docs/_index.md index 6f1fe7198..dd20d85e7 100755 --- a/content/cn/docs/_index.md +++ b/content/cn/docs/_index.md @@ -51,8 +51,8 @@ Apache HugeGraph 是一套完整的图数据库生态系统，支持 OLTP 实时 | 模式 | 适用场景 | 数据规模 | |-----|---------|---------| -| **单机版** | 极速稳定、存算一体 | < 1000TB | -| **分布式** | 海量存储、存算分离 | >= 1000TB | +| **单机版** | 极速稳定、存算一体 | < 4TB | +| **分布式** | 海量存储、存算分离 | < 1000TB | | **Docker** | 快速体验 | 任意 | [📖 详细介绍](introduction/) diff --git a/content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md b/content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md index a619f2e18..8561312e5 100644 --- a/content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md +++ b/content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md @@ -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 的流程。 本地启动的核心与**脚本启动**是一样的： @@ -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) diff --git a/content/cn/docs/download/download.md b/content/cn/docs/download/download.md index 834f5d070..c588d14a7 100644 --- a/content/cn/docs/download/download.md +++ b/content/cn/docs/download/download.md @@ -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 | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -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 | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -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 | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/content/cn/docs/guides/faq.md b/content/cn/docs/guides/faq.md index cfd26d43c..0fb08eea6 100644 --- a/content/cn/docs/guides/faq.md +++ b/content/cn/docs/guides/faq.md @@ -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 版本中可用，官方后续不再单独维护 diff --git a/content/cn/docs/introduction/README.md b/content/cn/docs/introduction/README.md index ffb705964..fee95f291 100644 --- a/content/cn/docs/introduction/README.md +++ b/content/cn/docs/introduction/README.md @@ -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: 元数据管理和集群调度 @@ -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/知识图谱) | diff --git a/content/cn/docs/performance/api-preformance/_index.md b/content/cn/docs/performance/api-performance/_index.md similarity index 77% rename from content/cn/docs/performance/api-preformance/_index.md rename to content/cn/docs/performance/api-performance/_index.md index 94c00c1b1..7fc78749a 100644 --- a/content/cn/docs/performance/api-preformance/_index.md +++ b/content/cn/docs/performance/api-performance/_index.md @@ -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/) > 即将更新，敬请期待！ diff --git a/content/cn/docs/performance/api-preformance/hugegraph-api-0.2.md b/content/cn/docs/performance/api-performance/hugegraph-api-0.2.md similarity index 100% rename from content/cn/docs/performance/api-preformance/hugegraph-api-0.2.md rename to content/cn/docs/performance/api-performance/hugegraph-api-0.2.md diff --git a/content/cn/docs/performance/api-preformance/hugegraph-api-0.4.4.md b/content/cn/docs/performance/api-performance/hugegraph-api-0.4.4.md similarity index 100% rename from content/cn/docs/performance/api-preformance/hugegraph-api-0.4.4.md rename to content/cn/docs/performance/api-performance/hugegraph-api-0.4.4.md diff --git a/content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-Cassandra.md b/content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra.md similarity index 100% rename from content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-Cassandra.md rename to content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra.md diff --git a/content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-RocksDB.md b/content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb.md similarity index 100% rename from content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-RocksDB.md rename to content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb.md diff --git a/content/cn/docs/quickstart/client/hugegraph-client.md b/content/cn/docs/quickstart/client/hugegraph-client.md index 9480f89fe..39b5f66d3 100644 --- a/content/cn/docs/quickstart/client/hugegraph-client.md +++ b/content/cn/docs/quickstart/client/hugegraph-client.md @@ -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 说明 diff --git a/content/cn/docs/quickstart/computing/hugegraph-computer.md b/content/cn/docs/quickstart/computing/hugegraph-computer.md index fa30a4ce8..c49d6c1fc 100644 --- a/content/cn/docs/quickstart/computing/hugegraph-computer.md +++ b/content/cn/docs/quickstart/computing/hugegraph-computer.md @@ -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 @@ -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 < 注意：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 diff --git a/content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md b/content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md index 3393a26cd..599be5000 100644 --- a/content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md +++ b/content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md @@ -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 diff --git a/content/en/docs/SUMMARY.md b/content/en/docs/SUMMARY.md index 0e004bfa4..283ddb6fb 100644 --- a/content/en/docs/SUMMARY.md +++ b/content/en/docs/SUMMARY.md @@ -54,11 +54,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 diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index e63e3e592..405c8141b 100755 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -51,8 +51,8 @@ Apache HugeGraph is a complete graph database ecosystem, supporting OLTP real-ti | Mode | Use Case | Data Scale | |-----|---------|---------| -| **Standalone** | High-speed stable, compute-storage integrated | < 1000TB | -| **Distributed** | Massive storage, compute-storage separated | >= 1000TB | +| **Standalone** | High-speed stable, compute-storage integrated | < 4TB | +| **Distributed** | Massive storage, compute-storage separated | < 1000TB | | **Docker** | Quick start | Any | [📖 Detailed Introduction](introduction/) diff --git a/content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md b/content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md index 04f4426a1..72c5a9cc2 100644 --- a/content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md +++ b/content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md @@ -165,7 +165,7 @@ This is because Log4j2 uses asynchronous loggers. You can refer to the [official ### References -1. [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph/hugegraph-server/) +1. [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph/hugegraph-server): Instructions for setting up HugeGraph-Server. 2. [Local Debugging Guide for 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) diff --git a/content/en/docs/download/download.md b/content/en/docs/download/download.md index 2df19aa30..a1411cb20 100644 --- a/content/en/docs/download/download.md +++ b/content/en/docs/download/download.md @@ -9,13 +9,13 @@ weight: 2 > > - It is recommended to use the latest version of the HugeGraph software package. Please select Java11 for the runtime environment. > - To verify downloads, use the corresponding hash (SHA512), signature, and [Project Signature Verification KEYS](https://downloads.apache.org/incubator/hugegraph/KEYS). -> - Instructions for checking hash (SHA512) and signatures are on the [Validate Release](/docs/contribution-guidelines/validate-release/) page, and you can also refer to [ASF official instructions](https://www.apache.org/dyn/closer.cgi#verify). +> - Instructions for checking hash (SHA512) and signatures are on the [Validate Release](/docs/contribution-guidelines/validate-release) page, and you can also refer to [ASF official instructions](https://www.apache.org/dyn/closer.cgi#verify). > - Note: The version numbers of all components of HugeGraph have been kept consistent, and the version numbers of Maven repositories such as `client/loader/hubble/common` are the same. You can refer to these for dependency references [maven example](https://github.com/apache/hugegraph-toolchain#maven-dependencies). ### Latest Version 1.7.0 - Release Date: 2025-11-28 -- [Release Notes](/docs/changelog/hugegraph-1.7.0-release-notes/) +- [Release Notes](/docs/changelog/hugegraph-1.7.0-release-notes) #### Binary Packages @@ -25,7 +25,7 @@ weight: 2 #### Source Packages -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 | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -40,7 +40,7 @@ Please refer to [build from source](/docs/quickstart/hugegraph-server/). #### 1.5.0 - Release Date: 2024-12-10 -- [Release Notes](/docs/changelog/hugegraph-1.5.0-release-notes/) +- [Release Notes](/docs/changelog/hugegraph-1.5.0-release-notes) ##### Binary Packages @@ -51,13 +51,13 @@ Please refer to [build from source](/docs/quickstart/hugegraph-server/). ##### Source Packages | Server | Toolchain | AI | Computer | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [[Source](https://www.apache.org/dyn/closer.lua/incubator/hugegraph/1.5.0/apache-hugegraph-incubating-1.5.0-src.tar.gz?action=download)] [[Sign](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-incubating-1.5.0-src.tar.gz.asc)] [[SHA512](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-incubating-1.5.0-src.tar.gz.sha512)] | [[Source](https://www.apache.org/dyn/closer.lua/incubator/hugegraph/1.5.0/apache-hugegraph-toolchain-incubating-1.5.0-src.tar.gz?action=download)] [[Sign](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-toolchain-incubating-1.5.0-src.tar.gz.asc)] [[SHA512](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-toolchain-incubating-1.5.0-src.tar.gz.sha512)] | [[Source](https://www.apache.org/dyn/closer.lua/incubator/hugegraph/1.5.0/apache-hugegraph-ai-incubating-1.5.0-src.tar.gz?action=download)] [[Sign](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-ai-incubating-1.5.0-src.tar.gz.asc)] [[SHA512](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-ai-incubating-1.5.0-src.tar.gz.sha512)] | [[Source](https://www.apache.org/dyn/closer.lua/incubator/hugegraph/1.5.0/apache-hugegraph-computer-incubating-1.5.0-src.tar.gz?action=download)] [[Sign](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-computer-incubating-1.5.0-src.tar.gz.asc)] [[SHA512](https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-computer-incubating-1.5.0-src.tar.gz.sha512)] | #### 1.3.0 - Release Date: 2024-04-01 -- [Release Notes](/docs/changelog/hugegraph-1.3.0-release-notes/) +- [Release Notes](/docs/changelog/hugegraph-1.3.0-release-notes) ##### Binary Packages @@ -74,7 +74,7 @@ Please refer to [build from source](/docs/quickstart/hugegraph-server/). #### 1.2.0 - Release Date: 2023-12-28 -- [Release Notes](/docs/changelog/hugegraph-1.2.0-release-notes/) +- [Release Notes](/docs/changelog/hugegraph-1.2.0-release-notes) ##### Binary Packages @@ -91,7 +91,7 @@ Please refer to [build from source](/docs/quickstart/hugegraph-server/). #### 1.0.0 - Release Date: 2023-02-22 -- [Release Notes](/docs/changelog/hugegraph-1.0.0-release-notes/) +- [Release Notes](/docs/changelog/hugegraph-1.0.0-release-notes) ##### Binary Packages diff --git a/content/en/docs/guides/architectural.md b/content/en/docs/guides/architectural.md index 6890b23f7..2b03f920d 100644 --- a/content/en/docs/guides/architectural.md +++ b/content/en/docs/guides/architectural.md @@ -22,7 +22,7 @@ HugeGraph consists of three layers of functionality: the application layer, the - [Tools](/docs/quickstart/toolchain/hugegraph-tools): Command-line tools for deploying, managing, and backing up/restoring data in HugeGraph. - [Computer](/docs/quickstart/computing/hugegraph-computer): A distributed graph processing system (OLAP), which is an implementation of [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf) and can run on Kubernetes. - [Client](/docs/quickstart/client/hugegraph-client): A HugeGraph client written in Java. Users can use the Client to write Java code to operate HugeGraph. Python, Go, C++ and other language support will be provided in the future as needed. -- [Graph Engine Layer](/docs/quickstart/hugegraph/hugegraph-server/): +- [Graph Engine Layer](/docs/quickstart/hugegraph/hugegraph-server): - REST Server: Provides a RESTful API for querying graph/schema information, supports the [Gremlin](https://tinkerpop.apache.org/gremlin.html) and [Cypher](https://en.wikipedia.org/wiki/Cypher) query languages, and offers APIs for service monitoring and operations. - Graph Engine: Supports both OLTP and OLAP graph computation types, with OLTP implementing the [Apache TinkerPop3](https://tinkerpop.apache.org) framework. - Backend Interface: Implements the storage of graph data to the backend. diff --git a/content/en/docs/guides/faq.md b/content/en/docs/guides/faq.md index b4b6cc502..2586164e5 100644 --- a/content/en/docs/guides/faq.md +++ b/content/en/docs/guides/faq.md @@ -7,7 +7,7 @@ weight: 6 - How to choose the back-end storage? RocksDB or distributed storage? HugeGraph supports multiple deployment modes. Choose based on your data scale and scenario: - - **Standalone Mode**: Server + RocksDB, suitable for development/testing and small to medium-scale data (< 1TB) + - **Standalone Mode**: Server + RocksDB, suitable for development/testing and small to medium-scale data (< 4TB) - **Distributed Mode**: HugeGraph-PD + HugeGraph-Store (HStore), supports horizontal scaling and high availability (< 1000TB data scale), suitable for production environments and large-scale graph data applications Note: Cassandra, HBase, MySQL and other backends are only available in HugeGraph <= 1.5 versions and are no longer maintained by the official team diff --git a/content/en/docs/introduction/README.md b/content/en/docs/introduction/README.md index 4f3cc5514..dc3a0f0d4 100644 --- a/content/en/docs/introduction/README.md +++ b/content/en/docs/introduction/README.md @@ -33,9 +33,9 @@ HugeGraph supports multiple deployment modes to meet different scales and scenar **Standalone Mode** - Server + RocksDB backend storage -- Suitable for development, testing, and small-to-medium scale data (< 1TB) +- Suitable for development, testing, and small-to-medium scale data (< 4TB) - Docker quick start: `docker run hugegraph/hugegraph` -- See [Server Quickstart](/docs/quickstart/hugegraph-server/hugegraph-server) +- See [Server Quickstart](/docs/quickstart/hugegraph/hugegraph-server) **Distributed Mode** - HugeGraph-PD: Metadata management and cluster scheduling @@ -47,7 +47,7 @@ HugeGraph supports multiple deployment modes to meet different scales and scenar | Use Case | Recommended Path | |---------|---------| -| Quick experience | [Docker deployment](/docs/quickstart/hugegraph-server/hugegraph-server#docker) | +| Quick experience | [Docker deployment](/docs/quickstart/hugegraph/hugegraph-server#docker) | | Build OLTP applications | Server → REST API / Gremlin / Cypher | | Graph analysis (OLAP) | [Vermeer](/docs/quickstart/computing/hugegraph-computer) (recommended) or Computer | | Build AI applications | [HugeGraph-AI](/docs/quickstart/hugegraph-ai) (GraphRAG/Knowledge Graph) | @@ -71,7 +71,7 @@ HugeGraph supports multiple deployment modes to meet different scales and scenar - [HugeGraph-Store]: HugeGraph-Store is a distributed storage engine to manage large-scale graph data by integrating storage and computation within a unified system. - [HugeGraph-PD]: HugeGraph-PD (Placement Driver) manages metadata and coordinates storage nodes. -- [HugeGraph-Server](/docs/quickstart/hugegraph-server): HugeGraph-Server is the core part of the HugeGraph project, containing Core, Backend, API and other submodules; +- [HugeGraph-Server](/docs/quickstart/hugegraph/hugegraph-server): HugeGraph-Server is the core part of the HugeGraph project, containing Core, Backend, API and other submodules; - Core: Implements the graph engine, connects to the Backend module downwards, and supports the API module upwards; - Backend: Implements the storage of graph data to the backend, supports backends including Memory, Cassandra, ScyllaDB, RocksDB, HBase, MySQL and PostgreSQL, users can choose one according to the actual situation; - API: Built-in REST Server provides RESTful API to users and is fully compatible with Gremlin queries. (Supports distributed storage and computation pushdown) diff --git a/content/en/docs/performance/api-preformance/_index.md b/content/en/docs/performance/api-performance/_index.md similarity index 70% rename from content/en/docs/performance/api-preformance/_index.md rename to content/en/docs/performance/api-performance/_index.md index d018a136f..5d08db000 100644 --- a/content/en/docs/performance/api-preformance/_index.md +++ b/content/en/docs/performance/api-performance/_index.md @@ -12,8 +12,7 @@ The HugeGraph API performance test mainly tests HugeGraph-Server's ability to co For the performance test of the RESTful API of each release version of HugeGraph, please refer to: -- [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/) +- [HugeGraph API-0.5.6-RocksDB](/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb) +- [HugeGraph API-0.5.6-Cassandra](/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra) > Updates coming soon, stay tuned! - diff --git a/content/en/docs/performance/api-preformance/hugegraph-api-0.2.md b/content/en/docs/performance/api-performance/hugegraph-api-0.2.md similarity index 100% rename from content/en/docs/performance/api-preformance/hugegraph-api-0.2.md rename to content/en/docs/performance/api-performance/hugegraph-api-0.2.md diff --git a/content/en/docs/performance/api-preformance/hugegraph-api-0.4.4.md b/content/en/docs/performance/api-performance/hugegraph-api-0.4.4.md similarity index 100% rename from content/en/docs/performance/api-preformance/hugegraph-api-0.4.4.md rename to content/en/docs/performance/api-performance/hugegraph-api-0.4.4.md diff --git a/content/en/docs/performance/api-preformance/hugegraph-api-0.5.6-Cassandra.md b/content/en/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra.md similarity index 100% rename from content/en/docs/performance/api-preformance/hugegraph-api-0.5.6-Cassandra.md rename to content/en/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra.md diff --git a/content/en/docs/performance/api-preformance/hugegraph-api-0.5.6-RocksDB.md b/content/en/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb.md similarity index 100% rename from content/en/docs/performance/api-preformance/hugegraph-api-0.5.6-RocksDB.md rename to content/en/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb.md diff --git a/content/en/docs/performance/hugegraph-loader-performance.md b/content/en/docs/performance/hugegraph-loader-performance.md index 77b55f3ff..686ce50a3 100644 --- a/content/en/docs/performance/hugegraph-loader-performance.md +++ b/content/en/docs/performance/hugegraph-loader-performance.md @@ -14,7 +14,7 @@ weight: 3 ## Use Cases When the number of graph data to be batch inserted (including vertices and edges) is at the billion level or below, -or the total data size is less than TB, the [HugeGraph-Loader](/docs/quickstart/hugegraph-loader) tool can be used to continuously and quickly import +or the total data size is less than TB, the [HugeGraph-Loader](/docs/quickstart/toolchain/hugegraph-loader) tool can be used to continuously and quickly import graph data. ## Performance diff --git a/content/en/docs/quickstart/computing/hugegraph-computer.md b/content/en/docs/quickstart/computing/hugegraph-computer.md index 9c1e8e903..f37139a2f 100644 --- a/content/en/docs/quickstart/computing/hugegraph-computer.md +++ b/content/en/docs/quickstart/computing/hugegraph-computer.md @@ -94,7 +94,7 @@ algorithm.params_class=org.apache.hugegraph.computer.algorithm.centrality.pagera #### 3.1.4 Start master node -> You can use `-c` parameter specify the configuration file, more computer config please see:[Computer Config Options](/docs/config/config-computer#computer-config-options) +> You can use `-c` parameter specify the configuration file, more computer config please see:[Computer Config Options](/docs/quickstart/computing/hugegraph-computer-config#computer-config-options) ```bash cd hugegraph-computer @@ -168,9 +168,9 @@ hugegraph-computer-operator-etcd-28lm67jxk5 1/1 Runnin #### 3.2.5 Submit a job -> More computer crd please see: [Computer CRD](/docs/config/config-computer#hugegraph-computer-crd) +> More computer crd please see: [Computer CRD](/docs/quickstart/computing/hugegraph-computer-config#hugegraph-computer-crd) > -> More computer config please see: [Computer Config Options](/docs/config/config-computer#computer-config-options) +> More computer config please see: [Computer Config Options](/docs/quickstart/computing/hugegraph-computer-config#computer-config-options) **Basic Example:** diff --git a/content/en/docs/quickstart/hugegraph-spark.md b/content/en/docs/quickstart/hugegraph-spark.md index 2184e093b..92a287e23 100644 --- a/content/en/docs/quickstart/hugegraph-spark.md +++ b/content/en/docs/quickstart/hugegraph-spark.md @@ -11,7 +11,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。 +Before using HugeGraph-Spark, you need to deploy HugeGraph-Server and Spark. Please refer to [HugeGraph-Server Quick Start](/docs/quickstart/hugegraph/hugegraph-server) for HugeGraph-Server deployment. Additionally, since HugeGraph-Spark requires Spark GraphX, you also need to download Spark. This example uses apache-spark-2.1.1. ``` wget https://archive.apache.org/dist/spark/spark-2.1.1/spark-2.1.1-bin-hadoop2.7.tgz diff --git a/dist/README.md b/dist/README.md index 0ccdb8ce4..3d71fc930 100644 --- a/dist/README.md +++ b/dist/README.md @@ -1,6 +1,6 @@ # Apache HugeGraph 发版验证脚本 -Apache HugeGraph (Incubating) 发布包的自动化验证脚本。 +Apache HugeGraph 发布包的自动化验证脚本。 ## 概述 diff --git a/dist/validate-links.sh b/dist/validate-links.sh new file mode 100755 index 000000000..2d4bd3972 --- /dev/null +++ b/dist/validate-links.sh @@ -0,0 +1,66 @@ +#!/bin/bash + +# Configuration +CONTENT_DIR="content" +EXIT_CODE=0 + +echo "Starting link validation..." + +# Find all markdown files and verify links +while read -r FILE; do + # Extract internal links starting with /docs/ or /cn/docs/ + # We look for [text](url) pattern where url starts with /docs/ or /cn/docs/ + # Using grep to find all matching links in the file + while read -r MATCH; do + if [ -z "$MATCH" ]; then continue; fi + + # Extract URL from ](url) + LINK=${MATCH#*](} + LINK=${LINK%)} + + # Remove anchor and query parameters + CLEAN_LINK=$(echo "$LINK" | cut -d'#' -f1 | cut -d'?' -f1) + CLEAN_LINK=${CLEAN_LINK%/} + + # Determine target file path based on language prefix + if [[ "$CLEAN_LINK" == /docs/* ]]; then + TARGET_PATH="content/en${CLEAN_LINK}" + elif [[ "$CLEAN_LINK" == /cn/docs/* ]]; then + TARGET_PATH="content${CLEAN_LINK}" + else + continue + fi + + # Check for file existence variations + FOUND=false + + # Check 1: As .md file + if [[ -f "${TARGET_PATH}.md" ]]; then + FOUND=true + # Check 2: Exact file (if extension was included) + elif [[ -f "$TARGET_PATH" ]]; then + FOUND=true + # Check 3: Directory index + elif [[ -f "${TARGET_PATH}/_index.md" ]]; then + FOUND=true + # Check 4: Directory README (legacy) + elif [[ -f "${TARGET_PATH}/README.md" ]]; then + FOUND=true + fi + + if [ "$FOUND" = false ]; then + echo "Error: Broken link in $FILE" + echo " Link: $LINK" + echo " Target: $TARGET_PATH (and variants)" + EXIT_CODE=1 + fi + done < <(grep -oE '\]\((/docs/|/cn/docs/)[^)]+\)' "$FILE") +done < <(find "$CONTENT_DIR" -type f -name "*.md") + +if [ $EXIT_CODE -eq 0 ]; then + echo "Link validation passed!" +else + echo "Link validation failed!" +fi + +exit $EXIT_CODE diff --git a/dist/validate-release.sh b/dist/validate-release.sh index cf39fdc6f..2109ecc18 100755 --- a/dist/validate-release.sh +++ b/dist/validate-release.sh @@ -1,4 +1,5 @@ #!/usr/bin/env bash +# TODO: Update for TLP graduation after ASF infra migration is complete. ################################################################################ # Apache HugeGraph Release Validation Script ################################################################################