Skip to content

Commit 202d930

Browse files
bitflicker64bitflicker64
authored
feat: harden documentation link validation to prevent false CI passes (#452)
* feat: enhance link validator to catch all internal links - Add support for relative link validation - Check absolute root paths (e.g., /language/*) - Skip asset files (.png, .xml, .css, etc.) - Strip code blocks from validation - Add case-insensitive protocol detection
1 parent 486e0b8 commit 202d930

21 files changed

Lines changed: 404 additions & 188 deletions

File tree

‎content/cn/docs/SUMMARY.md‎

Lines changed: 61 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,77 @@
11
# HugeGraph Docs
22

3-
* [Download](download.md)
3+
* [Download](download/download)
44

55
## Quickstart
6-
* [Install HugeGraph-Server](quickstart/hugegraph-server.md)
7-
* [Load data with HugeGraph-Loader](quickstart/hugegraph-loader.md)
8-
* [Visual with HugeGraph-Hubble](quickstart/hugegraph-hubble.md)
9-
* [Develop with HugeGraph-Client](quickstart/hugegraph-client.md)
10-
* [Manage with HugeGraph-Tools](quickstart/hugegraph-tools.md)
11-
* [Analysis with HugeGraph-Computer](quickstart/hugegraph-computer.md)
12-
* [Display with HugeGraph-Studio](quickstart/hugegraph-studio.md)
6+
* [Install HugeGraph-Server](quickstart/hugegraph/hugegraph-server)
7+
* [Load data with HugeGraph-Loader](quickstart/toolchain/hugegraph-loader)
8+
* [Visual with HugeGraph-Hubble](quickstart/toolchain/hugegraph-hubble)
9+
* [Develop with HugeGraph-Client](quickstart/client/hugegraph-client)
10+
* [Manage with HugeGraph-Tools](quickstart/toolchain/hugegraph-tools)
11+
* [Analysis with HugeGraph-Computer](quickstart/computing/hugegraph-computer)
1312

1413
## Config
15-
* [Config Guide](config/config-guide.md)
16-
* [Config Options](config/config-option.md)
17-
* [Config Authentication](config/config-authentication.md)
18-
* [Config HTTPS](config/config-https.md)
19-
* [Config Computer](config/config-computer.md)
14+
* [Config Guide](config/config-guide)
15+
* [Config Options](config/config-option)
16+
* [Config Authentication](config/config-authentication)
17+
* [Config HTTPS](config/config-https)
18+
* [Config Computer](quickstart/computing/hugegraph-computer)
2019

2120
## API
22-
* [RESTful API](clients/hugegraph-api.md)
23-
* [Schema](clients/restful-api/schema.md)
24-
* [PropertyKey](clients/restful-api/propertykey.md)
25-
* [VertexLabel](clients/restful-api/vertexlabel.md)
26-
* [EdgeLabel](clients/restful-api/edgelabel.md)
27-
* [IndexLabel](clients/restful-api/indexlabel.md)
28-
* [Rebuild](clients/restful-api/rebuild.md)
29-
* [Vertex](clients/restful-api/vertex.md)
30-
* [Edge](clients/restful-api/edge.md)
31-
* [Traverser](clients/restful-api/traverser.md)
32-
* [Rank](clients/restful-api/rank.md)
33-
* [Variable](clients/restful-api/variable.md)
34-
* [Graphs](clients/restful-api/graphs.md)
35-
* [Task](clients/restful-api/task.md)
36-
* [Gremlin](clients/restful-api/gremlin.md)
37-
* [Cypher](clients/restful-api/cypher.md)
38-
* [Authentication](clients/restful-api/auth.md)
39-
* [Other](clients/restful-api/other.md)
40-
* [Java Client](clients/hugegraph-client.md)
41-
* [Gremlin Console](clients/gremlin-console.md)
21+
* [RESTful API](clients/restful-api)
22+
* [Schema](clients/restful-api/schema)
23+
* [PropertyKey](clients/restful-api/propertykey)
24+
* [VertexLabel](clients/restful-api/vertexlabel)
25+
* [EdgeLabel](clients/restful-api/edgelabel)
26+
* [IndexLabel](clients/restful-api/indexlabel)
27+
* [Rebuild](clients/restful-api/rebuild)
28+
* [Vertex](clients/restful-api/vertex)
29+
* [Edge](clients/restful-api/edge)
30+
* [Traverser](clients/restful-api/traverser)
31+
* [Rank](clients/restful-api/rank)
32+
* [Variable](clients/restful-api/variable)
33+
* [Graphs](clients/restful-api/graphs)
34+
* [Task](clients/restful-api/task)
35+
* [Gremlin](clients/restful-api/gremlin)
36+
* [Cypher](clients/restful-api/cypher)
37+
* [Authentication](clients/restful-api/auth)
38+
* [Other](clients/restful-api/other)
39+
* [Java Client](clients/hugegraph-client)
40+
* [Gremlin Console](clients/gremlin-console)
4241

4342
## Guides
44-
* [Architecture Overview](guides/architectural.md)
45-
* [Design Concepts](guides/desgin-concept.md)
46-
* [Custom Plugins](guides/custom-plugin.md)
47-
* [Backup Restore](guides/backup-restore.md)
48-
* [FAQ](guides/faq.md)
43+
* [Architecture Overview](guides/architectural)
44+
* [Design Concepts](guides/desgin-concept)
45+
* [Custom Plugins](guides/custom-plugin)
46+
* [Backup Restore](guides/backup-restore)
47+
* [FAQ](guides/faq)
4948

5049
## Query Language
51-
* [Gremlin Query Language](language/hugegraph-gremlin.md)
52-
* [HugeGraph Examples](language/hugegraph-example.md)
50+
* [Gremlin Query Language](language/hugegraph-gremlin)
51+
* [HugeGraph Examples](language/hugegraph-example)
5352

5453
## Performance
55-
* [HugeGraph Benchmark Performance](performance/hugegraph-benchmark-0.5.6.md)
56-
* [HugeGraph API Performance-Outdated](content/cn/docs/performance/api-performance/_index.md)
57-
* [v0.5.6 Stand-alone(RocksDB)](content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-rocksdb.md)
58-
* [v0.5.6 Cluster(Cassandra)](content/cn/docs/performance/api-performance/hugegraph-api-0.5.6-cassandra.md)
59-
* [v0.4.4](content/cn/docs/performance/api-performance/hugegraph-api-0.4.4.md)
60-
* [v0.2](content/cn/docs/performance/api-performance/hugegraph-api-0.2.md)
61-
* [HugeGraph-Loader Performance](performance/hugegraph-loader-performance.md)
54+
* [HugeGraph Benchmark Performance](performance/hugegraph-benchmark-0.5.6)
55+
* [HugeGraph API Performance-Outdated](performance/api-performance)
56+
* [v0.5.6 Stand-alone(RocksDB)](performance/api-performance/hugegraph-api-0.5.6-rocksdb)
57+
* [v0.5.6 Cluster(Cassandra)](performance/api-performance/hugegraph-api-0.5.6-cassandra)
58+
* [v0.4.4](performance/api-performance/hugegraph-api-0.4.4)
59+
* [v0.2](performance/api-performance/hugegraph-api-0.2)
60+
* [HugeGraph-Loader Performance](performance/hugegraph-loader-performance)
6261

6362
## ChangeLogs
64-
* [Release-1.3.0](changelog/hugegraph-1.3.0-release-notes.md)
65-
* [Release-1.2.0](changelog/hugegraph-1.2.0-release-notes.md)
66-
* [Release-1.0.0](changelog/hugegraph-1.0.0-release-notes.md)
67-
68-
---
69-
70-
* [Release-0.12.0](changelog/hugegraph-0.12.0-release-notes.md)
71-
* [Release-0.11.2](changelog/hugegraph-0.11.2-release-notes.md)
72-
* [Release-0.10.4](changelog/hugegraph-0.10.4-release-notes.md)
73-
* [Release-0.9.2](changelog/hugegraph-0.9.2-release-notes.md)
74-
* [Release-0.8.0](changelog/hugegraph-0.8.0-release-notes.md)
75-
* [Release-0.7.4](changelog/hugegraph-0.7.4-release-notes.md)
76-
* [Release-0.6.1](changelog/hugegraph-0.6.1-release-notes.md)
77-
* [Release-0.5.6](changelog/hugegraph-0.5.6-release-notes.md)
78-
* [Release-0.4.4](changelog/hugegraph-0.4.4-release-notes.md)
79-
* [Release-0.3.3](changelog/hugegraph-0.3.3-release-notes.md)
80-
* [Release-0.2.4](changelog/hugegraph-0.2.4-release-notes.md)
81-
* [Release-0.2](changelog/hugegraph-0.2-release-notes.md)
63+
* [Release-1.3.0](changelog/hugegraph-1.3.0-release-notes)
64+
* [Release-1.2.0](changelog/hugegraph-1.2.0-release-notes)
65+
* [Release-1.0.0](changelog/hugegraph-1.0.0-release-notes)
66+
* [Release-0.12.0](changelog/hugegraph-0.12.0-release-notes)
67+
* [Release-0.11.2](changelog/hugegraph-0.11.2-release-notes)
68+
* [Release-0.10.4](changelog/hugegraph-0.10.4-release-notes)
69+
* [Release-0.9.2](changelog/hugegraph-0.9.2-release-notes)
70+
* [Release-0.8.0](changelog/hugegraph-0.8.0-release-notes)
71+
* [Release-0.7.4](changelog/hugegraph-0.7.4-release-notes)
72+
* [Release-0.6.1](changelog/hugegraph-0.6.1-release-notes)
73+
* [Release-0.5.6](changelog/hugegraph-0.5.6-release-notes)
74+
* [Release-0.4.4](changelog/hugegraph-0.4.4-release-notes)
75+
* [Release-0.3.3](changelog/hugegraph-0.3.3-release-notes)
76+
* [Release-0.2.4](changelog/hugegraph-0.2.4-release-notes)
77+
* [Release-0.2](changelog/hugegraph-0.2-release-notes)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1049,7 +1049,7 @@ GET http://localhost:8080/graphspaces/DEFAULT/auth/accesses/S-69:all>-88>11>S-77
10491049

10501050
### 10.7 图空间管理员（Manager）API
10511051

1052-
**重要提示**：在使用以下 API 之前，需要先创建图空间（graphspace）。请参考 [Graphspace API](../graphspace) 创建名为 `gs1` 的图空间。文档中的示例均假设已存在名为 `gs1` 的图空间
1052+
**重要提示**：在使用以下 API 之前，需要先创建图空间（graphspace）。请参考 [Graphspace API](./graphspace) 创建名为 `gs1` 的图空间。文档中的示例均假设已存在名为 `gs1` 的图空间
10531053

10541054
1. 图空间管理员 API 用于在 graphspace 维度给用户授予/回收管理员角色，并查询当前用户或其他用户在该 graphspace 下的角色信息。角色类型可取 `SPACE`、`SPACE_MEMBER`、`ADMIN` 。
10551055

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,4 +311,4 @@ DELETE http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/edgelab
311311

312312
注：
313313

314-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
314+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin
229229

230230
注：
231231

232-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
232+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)
233233
234234
**查询边**
235235

@@ -260,4 +260,4 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin
260260

261261
注：
262262

263-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/2`（其中"2"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
263+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/2`（其中"2"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,4 +174,4 @@ DELETE http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/indexla
174174

175175
注：
176176

177-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
177+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)

‎content/cn/docs/clients/restful-api/rebuild.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/inde
3131

3232
注：
3333

34-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
34+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)
3535
3636
#### 1.6.2 VertexLabel 对应的全部索引重建
3737

@@ -57,7 +57,7 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/vert
5757

5858
注：
5959

60-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/2`（其中"2"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
60+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/2`（其中"2"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)
6161
6262
#### 1.6.3 EdgeLabel 对应的全部索引重建
6363

@@ -83,4 +83,4 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/edge
8383

8484
注：
8585

86-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/3`（其中"3"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
86+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/3`（其中"3"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)

‎content/cn/docs/clients/restful-api/vertexlabel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,4 +308,4 @@ DELETE http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/vertexl
308308

309309
注：
310310

311-
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](../task)
311+
> 可以通过`GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/tasks/1`（其中"1"是 task_id）来查询异步任务的执行状态，更多[异步任务 RESTful API](./task)

‎content/cn/docs/config/config-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ ssl: {
138138

139139
- graphs：GremlinServer 启动时需要打开的图，该项是一个 map 结构，key 是图的名字，value 是该图的配置文件路径；
140140
- channelizer：GremlinServer 与客户端有两种通信方式，分别是 WebSocket 和 HTTP（默认）。如果选择 WebSocket，
141-
用户可以通过 [Gremlin-Console](/clients/gremlin-console.html) 快速体验 HugeGraph 的特性，但是不支持大规模数据导入，
141+
用户可以通过 [Gremlin-Console](../clients/gremlin-console) 快速体验 HugeGraph 的特性，但是不支持大规模数据导入，
142142
推荐使用 HTTP 的通信方式，HugeGraph 的外围组件都是基于 HTTP 实现的；
143143

144144
默认 GremlinServer 是服务在 localhost:8182，如果需要修改，配置 host、port 即可

‎content/cn/docs/contribution-guidelines/contribute.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
7474
# run test locally (optional)
7575
mvn test -Pcore-test,memory
7676
```
77-
Note: In order to be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml).
77+
Note: In order to be consistent with the code style easily, if you use IDEA as your IDE, you can import our code style configuration file.
7878

7979
##### 3.2.1 添加第三方依赖
8080

‎content/cn/docs/quickstart/hugegraph-studio.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ graph.schema().propertyKey("price").asInt().ifNotExist().create()
145145
**在这里有几点需要说明**
146146

147147
1、上述语句是`groovy`语言形式（类似但不是`java`）的`gremlin`语句，这些`gremlin`语句会被发送到`HugeGraphServer`上执行。
148-
关于`gremlin`本身可以参考[Gremlin Query Language](/language/hugegraph-gremlin.md)或[Tinkerpop官网](http://tinkerpop.apache.org/)；
148+
关于`gremlin`本身可以参考[Gremlin Query Language](../language/hugegraph-gremlin)或[Tinkerpop官网](http://tinkerpop.apache.org/)；
149149

150150
2、上述语句是通过`graph.schema()`获取到`SchemaManager`对象后操作元数据，通过`gremlin`语句操作Schema可参考文档[HugeGraph-Client](/docs/clients/hugegraph-client)，
151151
需要注意的是`HugeGraph-Client`是`java`语法，大体上与`gremlin`风格是一致的，具体的差异见文档`HugeGraph-Client`中的说明。

0 commit comments

Comments
 (0)