imbajin commented on code in PR #444: URL: https://github.com/apache/incubator-hugegraph-doc/pull/444#discussion_r2704505135
########## content/en/docs/clients/restful-api/graphs.md: ########## @@ -167,6 +167,8 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph2 ##### Request Body Create a non-auth graph (set `Content-Type: application/json`) +**Note**!! For version 1.7.0 and earlier, if the backend is hstore, you must add "task.scheduler_type": "distributed" in +the request body Review Comment: ‼️ **Critical Issue - Missing hstore complete example** The new note at line 170 mentions that hstore backend requires `task.scheduler_type: distributed` for version 1.7.0 and earlier, but there is no complete example showing this configuration in the "Create graph" section. **Suggestion:** Add a complete hstore example in section 6.1.5 to help users understand the full configuration: ```json { "gremlin.graph": "org.apache.hugegraph.HugeFactory", "backend": "hstore", "serializer": "binary", "store": "hugegraph2", "task.scheduler_type": "distributed", "pd.peers": "127.0.0.1:8686" } ``` This would make the documentation much more user-friendly for new hstore users. ########## content/cn/docs/clients/restful-api/graphs.md: ########## @@ -167,6 +167,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph-xx ##### Request Body 创建一个非鉴权模式的图（设置 `Content-Type: application/json`） +**注意**！！1.7.0 及之前，如果 backend 是 hstore，必须在请求体加上 "task.scheduler_type": "distributed" Review Comment: ‼️ **Critical Issue - Missing hstore complete example (CN version)** 第 170 行提到 hstore 后端在 1.7.0 及之前版本需要 `task.scheduler_type: distributed`，但在「创建图」章节没有提供完整的 hstore 示例。 **建议:** 在 6.1.5 节添加完整的 hstore 示例，帮助用户理解完整配置: ```json { "gremlin.graph": "org.apache.hugegraph.HugeFactory", "backend": "hstore", "serializer": "binary", "store": "hugegraph2", "task.scheduler_type": "distributed", "pd.peers": "127.0.0.1:8686" } ``` 这样对想使用 hstore 后端的新用户会更友好。 ########## content/cn/docs/quickstart/hugegraph/hugegraph-server.md: ########## @@ -200,10 +200,26 @@ task.scheduler_type=distributed pd.peers=127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688 ``` +```properties +# 简单示例（带鉴权） Review Comment: ⚠️ **Important - Inconsistent configuration between hugegraph-server.md and graphs.md** In `hugegraph-server.md` line 197, you added `task.scheduler_type=distributed` to the hugegraph.properties configuration. However, the simplified example starting at line 204 is missing this required parameter. For consistency and to avoid user confusion, the simplified example should also include: ```properties task.scheduler_type=distributed ``` This is especially important since the note in graphs.md:170 states this is **required** for hstore in version 1.7.0 and earlier. ########## content/en/docs/quickstart/hugegraph/hugegraph-server.md: ########## @@ -216,10 +216,26 @@ task.scheduler_type=distributed pd.peers=127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688 ``` +```properties +# Full example (with authentication) Review Comment: ⚠️ **Important - Missing task.scheduler_type in English version** Same issue as the Chinese version - the simplified example starting at line 220 is missing `task.scheduler_type=distributed` which is required for hstore backend (as noted in graphs.md:171). **Suggestion:** Add to the configuration example: ```properties task.scheduler_type=distributed ``` ########## content/cn/docs/clients/restful-api/graphs.md: ########## @@ -167,6 +167,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph-xx ##### Request Body 创建一个非鉴权模式的图（设置 `Content-Type: application/json`） +**注意**！！1.7.0 及之前，如果 backend 是 hstore，必须在请求体加上 "task.scheduler_type": "distributed" Review Comment: 🧹 **Minor - Consider adding cross-reference link** For better user experience, consider adding a link to the hugegraph-server.md configuration guide here, since users dynamically creating hstore graphs via API also need to configure the server properly first. **Suggestion:** ```markdown **注意**！！1.7.0 及之前，如果 backend 是 hstore，必须在请求体加上 "task.scheduler_type": "distributed"。同时需要确保 HugeGraph-Server 已正确配置 PD，详见[配置 HStore](/cn/docs/quickstart/hugegraph/hugegraph-server/#511-分布式存储-hstore) ``` ########## content/en/docs/clients/restful-api/graphs.md: ########## @@ -167,6 +167,8 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph2 ##### Request Body Create a non-auth graph (set `Content-Type: application/json`) +**Note**!! For version 1.7.0 and earlier, if the backend is hstore, you must add "task.scheduler_type": "distributed" in +the request body Review Comment: 🧹 **Minor - Consider adding cross-reference link (EN)** For better user experience, consider adding a link to the hugegraph-server.md configuration guide. **Suggestion:** ```markdown **Note**!! For version 1.7.0 and earlier, if the backend is hstore, you must add "task.scheduler_type": "distributed" in the request body. Also ensure HugeGraph-Server is properly configured with PD, see [HStore Configuration](/docs/quickstart/hugegraph/hugegraph-server/#511-distributed-storage-hstore) ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
