doc: add toolchain local test DOC for this repo#2
doc: add toolchain local test DOC for this repo#2sadwitdastreetz wants to merge 19 commits intohugegraph:masterfrom
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Walkthrough新增中英文两份《HugeGraph 工具链本地测试指南》文档，多个 quickstart 页面插入或提示该指南，调整若干指南的 front-matter weight，并将 GitHub Actions 工作流显示名从 Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor as 贡献者
participant GitHub as GitHub
participant Workflow as GitHub Actions (auto-pr-review)
participant Step as create-or-update-comment@v4
Note over Contributor,GitHub: 提交或更新 PR（pull_request_target 触发）
Contributor->>GitHub: 提交/更新 PR
GitHub->>Workflow: 触发 workflow（仅名称变更）
Workflow->>Step: 执行评论步骤（逻辑不变）
Step->>GitHub: 在 PR 上创建或更新评论
GitHub->>Contributor: 评论显示在 PR 页面
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@codecov-ai-reviewer review |
This comment has been minimized.
This comment has been minimized.
![codecov-ai[bot]](https://avatars.githubusercontent.com/in/797565?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
content/en/docs/guides/toolchain-local-test.md (1)
53-57: 无序列表缩进不符合 markdownlint(MD007)目前每个列表项前缩进 0 个空格，随后子段落再缩进 4 个空格，导致 lint 报错。保持两空格缩进即可：
-* It is recommended to prioritize using a script for local deployment … -* Docker deployment is more suitable for quickly starting … +* It is recommended to prioritize using a script for local deployment … +* Docker deployment is more suitable for quickly starting …content/cn/docs/guides/toolchain-local-test.md (1)
54-57: 无序列表缩进不规范 (MD007)顶级列表项不应再缩进 4 个空格；保持两空格或零缩进即可，示例：
-* 推荐优先使用脚本进行本地部署 HugeGraph Server。 … -* Docker 部署方式更适合快速启动一个默认配置的 HugeGraph Server … +* 推荐优先使用脚本进行本地部署 HugeGraph Server。 … +* Docker 部署方式更适合快速启动一个默认配置的 HugeGraph Server …
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
content/en/docs/images/toolchain-test-mermaid-1.pngis excluded by!**/*.pngcontent/en/docs/images/toolchain-test-mermaid-2.pngis excluded by!**/*.pngcontent/en/docs/images/toolchain-test-mermaid-3.pngis excluded by!**/*.pngcontent/en/docs/images/toolchain-test-mermaid-4.pngis excluded by!**/*.png
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~490-~490: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~490-~490: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/guides/toolchain-local-test.md
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
70-70: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
301-301: Link fragments should be valid
(MD051, link-fragments)
349-349: Link fragments should be valid
(MD051, link-fragments)
370-370: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
371-371: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
394-394: Link fragments should be valid
(MD051, link-fragments)
396-396: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
402-402: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
442-442: Link fragments should be valid
(MD051, link-fragments)
469-469: Link fragments should be valid
(MD051, link-fragments)
488-488: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
489-489: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
490-490: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
491-491: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
492-492: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
495-495: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
496-496: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
497-497: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
498-498: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
499-499: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
502-502: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
503-503: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
509-509: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
510-510: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
511-511: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
512-512: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
513-513: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
content/en/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
70-70: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
90-90: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
299-299: Link fragments should be valid
(MD051, link-fragments)
347-347: Link fragments should be valid
(MD051, link-fragments)
368-368: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
369-369: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
391-391: Link fragments should be valid
(MD051, link-fragments)
393-393: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
399-399: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
438-438: Link fragments should be valid
(MD051, link-fragments)
465-465: Link fragments should be valid
(MD051, link-fragments)
483-483: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
484-484: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
485-485: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
486-486: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
487-487: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
490-490: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
491-491: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
492-492: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
493-493: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
493-493: Link fragments should be valid
(MD051, link-fragments)
494-494: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
497-497: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
498-498: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
499-499: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
500-500: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
501-501: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
|
@codecov-ai-reviewer review |
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
content/en/docs/guides/toolchain-local-test.md (2)
276-278: 图片路径仍为绝对路径，易在多环境下解析失败
建议改为相对路径并确认static目录结构，或显式使用{{< relref >}}/{{< img >}}。-<img src="/docs/images/toolchain-test-mermaid-4.png" alt="HugeGraph Toolchain Testing Process"> +<img src="../../images/toolchain-test-mermaid-4.png" alt="HugeGraph Toolchain Testing Process">
97-101: 为标题补充 “3.2” 编号，保持层级一致
上一轮已指出该问题仍未修复，缺失编号会导致目录混乱及锚点失效。-### Using Docker to Deploy the Test Environment +### 3.2 Using Docker to Deploy the Test Environmentcontent/cn/docs/guides/toolchain-local-test.md (1)
282-283: 图片仍使用绝对路径，建议改为相对路径并补充 alt-<img src="/docs/images/toolchain-test-mermaid-2.png" alt="HugeGraph工具链测试流程图"> +<img src="../../images/toolchain-test-mermaid-2.png" alt="HugeGraph 工具链测试流程图">
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~492-~492: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~492-~492: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/guides/toolchain-local-test.md
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
303-303: Link fragments should be valid
(MD051, link-fragments)
351-351: Link fragments should be valid
(MD051, link-fragments)
372-372: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
373-373: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
396-396: Link fragments should be valid
(MD051, link-fragments)
398-398: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
404-404: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
444-444: Link fragments should be valid
(MD051, link-fragments)
471-471: Link fragments should be valid
(MD051, link-fragments)
490-490: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
491-491: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
492-492: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
493-493: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
494-494: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
497-497: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
498-498: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
499-499: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
500-500: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
500-500: Link fragments should be valid
(MD051, link-fragments)
501-501: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
511-511: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
512-512: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
513-513: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
514-514: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
515-515: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
content/en/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
70-70: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
90-90: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
299-299: Link fragments should be valid
(MD051, link-fragments)
347-347: Link fragments should be valid
(MD051, link-fragments)
368-368: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
369-369: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
391-391: Link fragments should be valid
(MD051, link-fragments)
393-393: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
399-399: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
438-438: Link fragments should be valid
(MD051, link-fragments)
465-465: Link fragments should be valid
(MD051, link-fragments)
483-483: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
484-484: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
485-485: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
486-486: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
487-487: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
490-490: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
491-491: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
492-492: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
493-493: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
493-493: Link fragments should be valid
(MD051, link-fragments)
494-494: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
497-497: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
498-498: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
499-499: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
500-500: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
501-501: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (7)
content/en/docs/guides/toolchain-local-test.md (3)
278-280: 图片使用绝对路径仍会导致 Hugo 站点中断链接
/docs/images/...为站点根目录绝对路径，发布到content/en下时 Hugo 不会自动解析。请改用相对于当前文档的相对路径，例如：-<img src="/docs/images/toolchain-test-mermaid-4.png" alt="HugeGraph Toolchain Testing Process"> +<img src="../../images/toolchain-test-mermaid-4.png" alt="HugeGraph Toolchain Testing Process">
317-318: 示例脚本仍硬编码弱密码pa在生产或公开文档中暴露固定密码存在安全隐患，建议改为占位符并提示用户替换：
-echo -e "pa" | bin/init-store.sh +echo -e "${YOUR_SECURE_PASSWORD}" | bin/init-store.sh # 请替换为安全密码
406-409:bin/bin路径重复且${version}未定义当前示例会导致路径找不到文件。建议使用通配符并移除冗余
bin/：-cd apache-hugegraph-hubble-incubating-${version}/bin/bin +cd apache-hugegraph-hubble-incubating-*/bin同时在脚本或文档顶部说明如何设置
${version}。content/cn/docs/guides/toolchain-local-test.md (4)
64-66: 描述重复，影响可读性出现两次“使用时直接接作为参数传递给”，请精简句子：
-确保测试环境与特定 HugeGraph Server 版本的一致性，这对于复现问题或验证兼容性至关重要。使用时直接接作为参数传递给 install-hugegraph-from-source.sh 脚本。 +确保测试环境与指定 HugeGraph Server 版本保持一致。请将该值作为参数传递给 `install-hugegraph-from-source.sh` 脚本。
310-321: 示例命令仍硬编码弱密码pa与英文版相同，建议改为占位符提醒用户自行设置安全密码：
-echo -e "pa" | bin/init-store.sh +echo -e "${YOUR_SECURE_PASSWORD}" | bin/init-store.sh # 请替换为安全密码
281-283: 图片路径仍为绝对路径请改为相对路径以确保在 Hugo 站点正确解析：
-<img src="/docs/images/toolchain-test-mermaid-2.png" alt="HugeGraph工具链测试流程图"> +<img src="../../images/toolchain-test-mermaid-2.png" alt="HugeGraph工具链测试流程图">
408-411:bin/bin路径重复且${version}未定义同英文版问题，正确示例：
-cd apache-hugegraph-hubble-incubating-${version}/bin/bin +cd apache-hugegraph-hubble-incubating-*/bin
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~492-~492: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~492-~492: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
92-92: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
370-370: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
371-371: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
395-395: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
401-401: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
485-485: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
486-486: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
487-487: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
488-488: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
489-489: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
492-492: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
493-493: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
494-494: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
495-495: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
495-495: Link fragments should be valid
(MD051, link-fragments)
496-496: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
499-499: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
500-500: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
501-501: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
502-502: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
503-503: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
509-509: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
510-510: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This PR adds comprehensive documentation for setting up a local testing environment for the HugeGraph toolchain, which is a great addition for developers. The guide is well-structured and covers various components and deployment methods. I've found a few issues, mainly related to incorrect commands in the Docker setup, broken links, and some inconsistencies between the Chinese and English versions. Addressing these will improve the accuracy and usability of the documentation.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (5)
content/cn/docs/guides/toolchain-local-test.md (3)
331-331: 步骤编号错误第331行的注释显示
# 3. 确认修改成功，但这应该是第2步（前面只有第1步备份），应改为：-# 3. 确认修改成功 +# 2. 确认修改成功
336-336: 文档中应使用密码占位符并添加安全提示审查意见的观察正确。文件中第336行和353行确实硬编码了测试密码
pa。建议通过使用占位符并添加明确的密码替换说明来改进，以遵循文档最佳实践并强调安全性：第336行：
-echo -e "pa" | bin/init-store.sh # 此脚本初始化 HugeGraph 存储并设置默认用户凭据，包括用于鉴权测试的密码 +echo -e "your_secure_password" | bin/init-store.sh # 请用安全密码替换 'your_secure_password'，此脚本初始化 HugeGraph 存储并设置默认用户凭据第353行：
-curl -u admin:pa http://localhost:8080/graphs +curl -u admin:your_password http://localhost:8080/graphs # 将 'your_password' 替换为服务器设置时使用的密码
237-243: 修正 HDFS 路径配置以避免数据丢失当用户取消注释 docker-compose 中的 Hadoop 配置时，
hdfs-site.xml中的路径/hadoop/hdfs/name和/hadoop/hdfs/data与 docker-compose 的卷挂载路径/hadoop/dfs/name和/hadoop/dfs/data不一致，导致 Hadoop 容器内的数据无法正确持久化到挂载的卷中。请统一修改为
/hadoop/dfs/name和/hadoop/dfs/data：<configuration> <property> <name>dfs.namenode.name.dir</name> - <value>/hadoop/hdfs/name</value> + <value>/hadoop/dfs/name</value> </property> <property> <name>dfs.datanode.data.dir</name> - <value>/hadoop/hdfs/data</value> + <value>/hadoop/dfs/data</value> </property>content/en/docs/guides/toolchain-local-test.md (2)
329-329: 步骤编号错误第329行的注释显示
# 3. Confirm the modification was successful，但这应该是第2步（前面只有第1步备份），应改为：-# 3. Confirm the modification was successful +# 2. Confirm the modification was successful
334-335: 在文档中移除硬编码密码，使用占位符并添加安全警告第334行包含硬编码的测试密码
pa，不应在公开文档中显示具体密码，即使是为了测试目的。这可能导致用户将测试密码误用于生产环境。建议将其替换为占位符并强调用户需要设置安全密码。-echo -e "pa" | bin/init-store.sh # This script initializes the HugeGraph store and sets default user credentials, including the password for authentication testing +echo -e "your_secure_password" | bin/init-store.sh # Replace 'your_secure_password' with a secure password. This script initializes the HugeGraph store and sets default user credentials for authentication testing
🧹 Nitpick comments (1)
content/cn/docs/guides/toolchain-local-test.md (1)
74-75: 优化表述清晰度第74-75行的脚本描述逻辑不够连贯，建议改为更清晰的单句表述：
-如果您选择手动安装，可以使用以下脚本来安装 HugeGraph Server。该脚本位于任意工具仓库的`/assembly/travis/` 目录下 -用于从指定 commit id 拉取 HugeGraph Server 源码、编译、解压并分别以 http/https 启动服务 +如果您选择手动安装，可以使用以下脚本来安装 HugeGraph Server。该脚本位于工具仓库的 `/assembly/travis/` 目录下，用于从指定 commit ID 拉取源码、编译、解压并分别以 HTTP/HTTPS 启动服务。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.28.0)
content/cn/docs/guides/toolchain-local-test.md
[high] 350-353: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
content/en/docs/guides/toolchain-local-test.md
[high] 348-351: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
🪛 LanguageTool
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~552-~552: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~552-~552: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
content/en/docs/guides/toolchain-local-test.md
[grammar] ~38-~38: Use a hyphen to join words.
Context: ...3.11 (only required for HugeGraph-Hubble related tests). It is recommended to use...
(QB_NEW_EN_HYPHEN)
[uncategorized] ~578-~578: The official name of this software platform is spelled with a capital “H”.
Context: ...ache.org/docs/) * CI Script Path: .github/workflows/*-ci.yml (CI configuration f...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
97-97: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
400-400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
401-401: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
423-423: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
427-427: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
441-441: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
451-451: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
546-546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
547-547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
548-548: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
549-549: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
550-550: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
553-553: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
554-554: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
555-555: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
556-556: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
560-560: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
562-562: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
563-563: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
567-567: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
569-569: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
570-570: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🔇 Additional comments (1)
content/en/docs/guides/toolchain-local-test.md (1)
313-313: 审查意见不正确根据文件内容验证，您指出需要修改的锚点引用已经是正确的状态：
- 第 313、379、425、501、528 行的锚点引用已经正确使用
#3-deploying-the-test-environment- 文档中的实际标题为
## 3. Deploying the Test Environment（第 49 行）- 所有提到的行已经与正确的格式相符
您在审查意见中所示的"错误状态"（
#deploying-the-test-environment）不存在于当前代码中。代码已经处于您建议的"修复后"状态。Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
content/cn/docs/guides/toolchain-local-test.md (3)
504-504: 清理重复文本第 504 行也存在类似的重复"部署测试环境"文本，建议改为：
-按照 [部署测试环境](#3-部署测试环境) 部署测试环境 中的说明，启动 `hugegraph-server` 。 +按照 [部署测试环境](#3-部署测试环境) 中的说明启动 `hugegraph-server`。
531-531: 清理重复文本第 531 行同样存在重复的"部署测试环境"文本，建议改为：
-按照 [部署测试环境](#3-部署测试环境) 部署测试环境 中的说明，启动 `hugegraph-server` 。 +按照 [部署测试环境](#3-部署测试环境) 中的说明启动 `hugegraph-server`。
381-381: 清理重复文本第 381 行在锚点引用处包含重复的"部署测试环境"文本，应改为：
-按照 [部署测试环境](#3-部署测试环境) 部署测试环境 中的说明，启动 `hugegraph-server`，`Hadoop (HDFS)` (仅当运行 HDFS 测试时需要)， `MySQL` (仅当运行 JDBC 测试时需要)。 +按照 [部署测试环境](#3-部署测试环境) 中的说明，启动 `hugegraph-server`、`Hadoop (HDFS)`（仅当运行 HDFS 测试时需要）和 `MySQL`（仅当运行 JDBC 测试时需要）。content/en/docs/guides/toolchain-local-test.md (1)
348-351: 修复硬编码的认证密码，使用占位符替换验证确认问题确实存在：第 351 行的 curl 命令中包含硬编码密码
pa。虽然这是文档示例代码，但在文档中展示硬编码凭证会误导用户采纳不安全的做法。建议将硬编码密码替换为清晰的占位符，引导用户输入实际密码。推荐使用以下任一方式修复：
-curl -u admin:pa http://localhost:8080/graphs +curl -u admin:<your_password> http://localhost:8080/graphs或
-curl -u admin:pa http://localhost:8080/graphs +curl -u admin:${HUGEGRAPH_PASSWORD} http://localhost:8080/graphs
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
content/cn/docs/images/toolchain-test-mermaid-1.pngis excluded by!**/*.pngcontent/cn/docs/images/toolchain-test-mermaid-2.pngis excluded by!**/*.png
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.28.0)
content/en/docs/guides/toolchain-local-test.md
[high] 348-351: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
content/cn/docs/guides/toolchain-local-test.md
[high] 350-353: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
🪛 LanguageTool
content/en/docs/guides/toolchain-local-test.md
[grammar] ~38-~38: Use a hyphen to join words.
Context: ...3.11 (only required for HugeGraph-Hubble related tests). It is recommended to use...
(QB_NEW_EN_HYPHEN)
[uncategorized] ~578-~578: The official name of this software platform is spelled with a capital “H”.
Context: ...ache.org/docs/) * CI Script Path: .github/workflows/*-ci.yml (CI configuration f...
(GITHUB)
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~552-~552: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~552-~552: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
97-97: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
400-400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
401-401: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
423-423: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
427-427: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
441-441: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
451-451: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
546-546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
547-547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
548-548: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
549-549: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
550-550: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
553-553: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
554-554: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
555-555: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
556-556: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
560-560: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
562-562: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
563-563: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
567-567: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
569-569: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
570-570: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
content/cn/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
97-97: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
400-400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
401-401: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
423-423: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
427-427: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
441-441: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
451-451: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
546-546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
547-547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
548-548: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
549-549: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
550-550: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
553-553: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
554-554: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
555-555: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
556-556: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
560-560: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
562-562: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
563-563: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
567-567: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
569-569: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
570-570: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🔇 Additional comments (4)
content/en/docs/guides/toolchain-local-test.md (2)
237-241: ✅ HDFS 路径配置已正确已确认
hdfs-site.xml中的路径/hadoop/dfs/name和/hadoop/dfs/data与 docker-compose.yml 中的卷挂载路径一致（第180、202行），数据将能正确持久化。
290-292: 确认镜像文件和相对路径第 291 行使用相对路径
./../images/toolchain-test-mermaid-2.png引用图片。请确保相关镜像文件已包含在 PR 中：
- content/en/docs/images/toolchain-test-mermaid-1.png
- content/en/docs/images/toolchain-test-mermaid-2.png
- content/en/docs/images/toolchain-test-mermaid-3.png
- content/en/docs/images/toolchain-test-mermaid-4.png
content/cn/docs/guides/toolchain-local-test.md (2)
293-295: 确认镜像文件和相对路径第 294 行使用相对路径
./../images/toolchain-test-mermaid-2.png引用图片。请确保相关镜像文件已包含在 PR 中：
- content/cn/docs/images/toolchain-test-mermaid-1.png
- content/cn/docs/images/toolchain-test-mermaid-2.png
- content/cn/docs/images/toolchain-test-mermaid-3.png
- content/cn/docs/images/toolchain-test-mermaid-4.png
239-243: 需要手动验证 HDFS 配置路径和其他问题原始审查评论提出了以下关键问题，但由于无法直接访问代码库进行验证，请人工确认：
HDFS 路径不匹配：hdfs-site.xml（第239-243行）中的
/hadoop/hdfs/name和/hadoop/hdfs/data是否与 docker-compose.yml（第182、204行）中的卷挂载路径一致。请检查 docker-compose.yml 中实际配置的卷挂载点。文本重复：请检查第381、504、531行是否存在重复的文本"部署测试环境 中的说明，启动"。
硬编码密码：请检查第353行是否包含硬编码密码，应将其替换为占位符或环境变量。
请验证这些问题是否在当前代码中确实存在，并按需要进行修正。
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
content/cn/docs/guides/toolchain-local-test.md (1)
235-254:⚠️ 严重问题：HDFS 配置路径与 docker-compose 卷挂载不匹配
hdfs-site.xml中配置的路径为/hadoop/hdfs/name（第239行）和/hadoop/hdfs/data（第243行），但 docker-compose.yml 中的卷挂载路径为/hadoop/dfs/name（第182行）和/hadoop/dfs/data（第204行）。由于路径不一致，Hadoop 将数据写入到未挂载的容器本地路径，容器重启后数据将丢失。对比英文版本：英文版本已正确使用
/hadoop/dfs/name和/hadoop/dfs/data（第237行和241行）。请统一修复中文版本。应用以下修改：
<configuration> <property> <name>dfs.namenode.name.dir</name> - <value>/hadoop/hdfs/name</value> + <value>/hadoop/dfs/name</value> </property> <property> <name>dfs.datanode.data.dir</name> - <value>/hadoop/hdfs/data</value> + <value>/hadoop/dfs/data</value> </property>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~552-~552: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~552-~552: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
content/en/docs/guides/toolchain-local-test.md
[grammar] ~38-~38: Use a hyphen to join words.
Context: ...3.11 (only required for HugeGraph-Hubble related tests). It is recommended to use...
(QB_NEW_EN_HYPHEN)
[uncategorized] ~578-~578: The official name of this software platform is spelled with a capital “H”.
Context: ...ache.org/docs/) * CI Script Path: .github/workflows/*-ci.yml (CI configuration f...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/guides/toolchain-local-test.md
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
402-402: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
403-403: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
426-426: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
430-430: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
444-444: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
454-454: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
550-550: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
551-551: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
552-552: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
553-553: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
554-554: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
558-558: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
559-559: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
560-560: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
565-565: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
566-566: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
567-567: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
572-572: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
573-573: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
574-574: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
575-575: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
content/en/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
97-97: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
400-400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
401-401: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
423-423: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
427-427: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
441-441: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
451-451: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
546-546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
547-547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
548-548: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
549-549: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
550-550: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
553-553: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
554-554: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
555-555: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
556-556: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
560-560: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
562-562: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
563-563: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
567-567: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
569-569: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
570-570: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🔇 Additional comments (6)
content/en/docs/guides/toolchain-local-test.md (4)
231-252: ✅ HDFS configuration paths are correctly aligned with docker-compose volumes.The paths in
hdfs-site.xml(/hadoop/dfs/nameand/hadoop/dfs/dataat lines 237 and 241) now match the volume mount paths in docker-compose.yml (lines 180 and 202), ensuring Hadoop can properly persist data to mounted volumes.
290-292: ✅ Image references use relative paths and include descriptive alt text.Image tags at lines 290-292 and 381-383 correctly use relative paths (
./../images/...) with meaningful alt text, which should resolve properly in the Hugo documentation site.Also applies to: 381-383
313-313: ✅ Internal anchor links consistently use numbered format.All internal references to "Deploying the Test Environment" correctly reference
#3-deploying-the-test-environment(e.g., lines 313, 379, 425, 501), matching the actual heading slug that includes the section number.Also applies to: 379-379, 425-425, 501-501
351-351: ✅ Authentication examples use password placeholders.Line 351 properly uses a placeholder
<your_password>with an inline comment instructing users to replace it with their actual password, following security best practices.content/cn/docs/guides/toolchain-local-test.md (2)
294-294: ✅ 图片路径使用相对格式且包含描述性 alt 文本第294行和384行的图片标签正确使用相对路径（
./../images/...）并包含有意义的中文 alt 文本，应能在 Hugo 文档站点中正确解析。Also applies to: 384-384
353-353: ✅ 鉴权示例使用密码占位符第353行正确使用占位符
<your_password>并通过内联注释指示用户替换为实际密码，遵循安全最佳实践。
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
content/cn/docs/guides/toolchain-local-test.md (1)
238-245: 🔴 严重问题：HDFS配置路径与docker-compose卷挂载不匹配hdfs-site.xml 中配置的路径为
/hadoop/hdfs/name和/hadoop/hdfs/data（第241、245行），但 docker-compose.yml 中卷挂载的路径为/hadoop/dfs/name和/hadoop/dfs/data（第182、204行）。路径不一致将导致 Hadoop 无法将数据正确持久化到挂载的卷中，容器重启后数据丢失。请参考英文版本（第236-243行），更新为正确的路径前缀。
应改为：
- <value>/hadoop/hdfs/name</value> + <value>/hadoop/dfs/name</value>- <value>/hadoop/hdfs/data</value> + <value>/hadoop/dfs/data</value>
🧹 Nitpick comments (1)
content/cn/docs/guides/toolchain-local-test.md (1)
432-432: 文本不完整：缺少"中的说明"短语第432行应包含 "中的说明" 以保持与英文版本（第429行）和其他类似段落（第385、508、535行）的一致性，改进句子的表达完整性。
应改为：
- 按照 [部署测试环境](#3-部署测试环境) 启动 HugeGraph Server。 + 按照 [部署测试环境](#3-部署测试环境) 中的说明 启动 HugeGraph Server。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/en/docs/guides/toolchain-local-test.md
[grammar] ~38-~38: Use a hyphen to join words.
Context: ...3.11 (only required for HugeGraph-Hubble related tests). It is recommended to use...
(QB_NEW_EN_HYPHEN)
[uncategorized] ~582-~582: The official name of this software platform is spelled with a capital “H”.
Context: ...ache.org/docs/) * CI Script Path: .github/workflows/*-ci.yml (CI configuration f...
(GITHUB)
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~556-~556: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：必要"地"依赖
Context: ...服务。 * 排查方法： * 确认所有必要的依赖服务（HugeGraph Server、MySQL、Hadoop 等）已正确...
(wb4)
[uncategorized] ~556-~556: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...SQL、Hadoop 等）已正确启动，且必须确保server的http服务运行在8080端口。 * 检查服务监听的端口是否与测试配置一致，并且没有被其他...
(wa5)
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/guides/toolchain-local-test.md
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
97-97: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
404-404: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
405-405: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
427-427: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
431-431: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
445-445: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
455-455: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
550-550: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
551-551: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
552-552: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
553-553: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
554-554: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
558-558: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
559-559: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
560-560: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
565-565: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
566-566: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
567-567: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
572-572: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
573-573: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
574-574: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
575-575: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
content/cn/docs/guides/toolchain-local-test.md
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
72-72: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
406-406: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
407-407: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
430-430: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
434-434: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
448-448: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
458-458: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
554-554: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
555-555: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
556-556: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
557-557: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
558-558: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
561-561: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
562-562: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
563-563: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
564-564: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
565-565: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
568-568: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
569-569: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
570-570: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
571-571: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
572-572: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
575-575: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
576-576: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
577-577: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
578-578: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
579-579: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🔇 Additional comments (4)
content/en/docs/guides/toolchain-local-test.md (3)
125-217: ✅ HDFS配置路径正确，与docker-compose卷挂载一致docker-compose.yml 中定义的卷挂载路径（第180、202行为
/hadoop/dfs/name和/hadoop/dfs/data）与 hdfs-site.xml 中的配置（第239、243行）保持一致，数据持久化配置正确。
292-294: 图片路径使用相对路径，适配Hugo站点结构图片引用采用相对路径
./../images/toolchain-test-mermaid-2.png，符合Hugo站点目录结构，能够正确解析。
354-356: 认证测试示例使用占位符，避免密码暴露curl命令中使用
<your_password>占位符并配有说明注释，明确指示用户需要替换实际密码（默认测试密码为"pa"），符合安全最佳实践。content/cn/docs/guides/toolchain-local-test.md (1)
356-357: ✅ 认证测试示例使用占位符，密码配置规范curl命令中使用
<your_password>占位符并包含说明注释，清楚地指示用户需要替换为实际密码（默认测试密码为"pa"），符合安全最佳实践。
Adjusted the 'weight' field for backup-restore, FAQ, and security guides in both Chinese and English to improve navigation order. Major rewrite and restructuring of the toolchain local test guide for clarity, conciseness, and step-by-step instructions, including environment setup, service deployment, and troubleshooting. Updated image paths for consistency.
Added references to the HugeGraph Toolchain Local Testing Guide in both Chinese and English quickstart documentation for Hubble, Loader, and Tools. This provides users with instructions for running local tests for each toolchain component.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
content/cn/docs/guides/toolchain-local-test.md (1)
215-220: 🔴 严重问题：HDFS配置路径与docker-compose卷挂载不匹配。
hdfs-site.xml中配置的路径为/hadoop/hdfs/name和/hadoop/hdfs/data，但docker-compose.yml中卷挂载的路径为/hadoop/dfs/name和/hadoop/dfs/data（第156行和178行）。路径不一致会导致Hadoop无法将数据正确持久化到挂载的卷，容器重启后数据将丢失。<configuration> <property> <name>dfs.namenode.name.dir</name> - <value>/hadoop/hdfs/name</value> + <value>/hadoop/dfs/name</value> </property> <property> <name>dfs.datanode.data.dir</name> - <value>/hadoop/hdfs/data</value> + <value>/hadoop/dfs/data</value> </property> <property> <name>dfs.permissions.superusergroup</name> <value>hadoop</value> </property> <property> <name>dfs.support.append</name> <value>true</value> </property> </configuration>
🧹 Nitpick comments (2)
content/en/docs/guides/toolchain-local-test.md (1)
295-295: 🔒 Hardcoded authentication password in example command.Line 295 contains a curl example with a hardcoded password
pa:curl -u admin:pa http://localhost:8080/graphs. While this is a test default mentioned in the documentation, displaying concrete credentials—even test ones—in examples can lead to poor security habits. Consider using a placeholder with a note.-curl -u admin:pa http://localhost:8080/graphs # Authentication test (pa is test default password) +curl -u admin:<password> http://localhost:8080/graphs # Replace <password> with the password set in step 2content/cn/docs/guides/toolchain-local-test.md (1)
293-293: 🔒 示例命令中硬编码了认证密码。第293行的curl示例包含硬编码的密码
pa：curl -u admin:pa http://localhost:8080/graphs。虽然这是文档中提到的测试默认密码，但在示例中显示具体凭证（即使是测试凭证）会导致不良的安全习惯。建议使用占位符并添加说明。-curl -u admin:pa http://localhost:8080/graphs # 鉴权测试（密码 pa 是测试默认值） +curl -u admin:<密码> http://localhost:8080/graphs # 将 <密码> 替换为第2步设置的密码
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (16)
content/cn/docs/guides/backup-restore.md(1 hunks)content/cn/docs/guides/faq.md(1 hunks)content/cn/docs/guides/security.md(1 hunks)content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/cn/docs/quickstart/toolchain/_index.md(1 hunks)content/cn/docs/quickstart/toolchain/hugegraph-hubble.md(1 hunks)content/cn/docs/quickstart/toolchain/hugegraph-loader.md(1 hunks)content/cn/docs/quickstart/toolchain/hugegraph-tools.md(1 hunks)content/en/docs/guides/backup-restore.md(1 hunks)content/en/docs/guides/faq.md(1 hunks)content/en/docs/guides/security.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/quickstart/toolchain/_index.md(1 hunks)content/en/docs/quickstart/toolchain/hugegraph-hubble.md(1 hunks)content/en/docs/quickstart/toolchain/hugegraph-loader.md(1 hunks)content/en/docs/quickstart/toolchain/hugegraph-tools.md(1 hunks)
✅ Files skipped from review due to trivial changes (11)
- content/en/docs/guides/security.md
- content/en/docs/quickstart/toolchain/hugegraph-loader.md
- content/en/docs/guides/backup-restore.md
- content/cn/docs/quickstart/toolchain/_index.md
- content/en/docs/guides/faq.md
- content/cn/docs/guides/security.md
- content/cn/docs/guides/faq.md
- content/cn/docs/guides/backup-restore.md
- content/cn/docs/quickstart/toolchain/hugegraph-hubble.md
- content/cn/docs/quickstart/toolchain/hugegraph-loader.md
- content/en/docs/quickstart/toolchain/_index.md
🧰 Additional context used
🪛 LanguageTool
content/en/docs/guides/toolchain-local-test.md
[uncategorized] ~444-~444: The official name of this software platform is spelled with a capital “H”.
Context: ...egraph-server/) * CI Script Path: .github/workflows/*-ci.yml (CI configuration f...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/guides/toolchain-local-test.md
56-56: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
69-69: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
79-79: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
344-344: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
352-352: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (5)
content/en/docs/quickstart/toolchain/hugegraph-hubble.md (1)
14-15: ✅ Clear cross-reference added.The new Testing Guide note is well-positioned and clearly directs users to the local testing documentation. No issues identified.
content/cn/docs/quickstart/toolchain/hugegraph-tools.md (1)
11-12: ✅ 中文测试指南引用已清晰添加。新增的测试指南note定位恰当，并正确链接到工具链本地测试文档的中文版本。无问题发现。
content/en/docs/quickstart/toolchain/hugegraph-tools.md (1)
11-12: ✅ Testing Guide reference added appropriately.The new note provides a clear reference to the toolchain local testing documentation. Consistent with similar changes across other quickstart files.
content/en/docs/guides/toolchain-local-test.md (2)
216-220: ✅ HDFS configuration paths correctly align with docker-compose volumes.The
hdfs-site.xmlconfiguration correctly specifies/hadoop/dfs/nameand/hadoop/dfs/data, which match the volume mount paths defined in the docker-compose configuration (lines 157 and 179). This ensures Hadoop can properly persist data to the mounted volumes.
444-444: Minor: GitHub capitalization.Line 444 should follow the official capitalization:
GitHub(notGithuborgithub).-* **CI Script Path**: `.github/workflows/*-ci.yml` (CI configuration files in the HugeGraph toolchain project, which can be used as a reference) +* **CI Script Path**: `.github/workflows/*-ci.yml` (CI configuration files in the HugeGraph toolchain project, which can be used as a reference)This appears to already be correct in the provided code, so no change needed.
| #### 部署步骤 | ||
|
|
||
| **1. 安装 HugeGraph Server** | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
多个位置使用强调格式（**text**）代替Markdown标题，违反了Markdown lint规则，可能影响文档结构和导航：
- 第56行：
**1. 安装 HugeGraph Server**→ 应为#### 1. 安装 HugeGraph Server - 第69行：
**2. 安装可选依赖**→ 应为#### 2. 安装可选依赖 - 第79行：
**3. 健康检查**→ 应为#### 3. 健康检查 - 第344行：
**2. Python 环境**→ 应为#### 2. Python 环境 - 第352行：
**3. 构建并验证**→ 应为#### 3. 构建并验证
-**1. 安装 HugeGraph Server**
+#### 1. 安装 HugeGraph Server
-**2. 安装可选依赖**
+#### 2. 安装可选依赖
-**3. 健康检查**
+#### 3. 健康检查
-**2. Python 环境**
+#### 2. Python 环境
-**3. 构建并验证**
+#### 3. 构建并验证Also applies to: 69-69, 79-79, 344-344, 352-352
🤖 Prompt for AI Agents
In content/cn/docs/guides/toolchain-local-test.md around lines 56, 69, 79, 344
and 352, several headings were written using bold/strong emphasis (e.g. **1. 安装
HugeGraph Server**) which violates MD036; replace each emphasized line with the
appropriate Markdown heading level (use #### before the text as suggested: ####
1. 安装 HugeGraph Server, #### 2. 安装可选依赖, #### 3. 健康检查, #### 2. Python 环境, #### 3.
构建并验证) so they become actual headings instead of bold text, preserving the
numbering and surrounding whitespace/line breaks.
… misleading informations
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (2)
content/cn/docs/guides/toolchain-local-test.md (1)
214-220: HDFS配置路径与docker-compose卷挂载不匹配在
hdfs-site.xml中配置的路径为/hadoop/hdfs/name和/hadoop/hdfs/data，但在docker-compose.yml中的卷挂载为/hadoop/dfs/name和/hadoop/dfs/data（第156行和178行）。这种不匹配会导致Hadoop数据无法正确持久化到挂载的卷中，容器重启后数据会丢失。应修改为：
<configuration> <property> <name>dfs.namenode.name.dir</name> - <value>/hadoop/hdfs/name</value> + <value>/hadoop/dfs/name</value> </property> <property> <name>dfs.datanode.data.dir</name> - <value>/hadoop/hdfs/data</value> + <value>/hadoop/dfs/data</value> </property>content/en/docs/guides/toolchain-local-test.md (1)
212-220: HDFS配置路径与docker-compose卷挂载不匹配在
hdfs-site.xml中配置的路径为/hadoop/hdfs/name和/hadoop/hdfs/data，但在docker-compose.yml中的卷挂载为/hadoop/dfs/name和/hadoop/dfs/data（第156行和178行）。这种不匹配会导致Hadoop数据无法正确持久化到挂载的卷中，容器重启后数据会丢失。应修改为：
<configuration> <property> <name>dfs.namenode.name.dir</name> - <value>/hadoop/hdfs/name</value> + <value>/hadoop/dfs/name</value> </property> <property> <name>dfs.datanode.data.dir</name> - <value>/hadoop/hdfs/data</value> + <value>/hadoop/dfs/data</value> </property>
🧹 Nitpick comments (3)
content/en/docs/guides/toolchain-local-test.md (1)
253-254: 图片路径使用绝对路径，可能在Hugo站点中无法正确加载图片引用使用的绝对路径
/docs/images/toolchain-test-mermaid-2.png在Hugo站点结构中可能无法解析。建议改为相对路径以确保兼容性：<div style="text-align: center;"> - <img src="/docs/images/toolchain-test-mermaid-2.png" alt="HugeGraph Toolchain Testing Process"> + <img src="../../images/toolchain-test-mermaid-2.png" alt="HugeGraph Toolchain Testing Process"> </div>content/cn/docs/guides/toolchain-local-test.md (2)
253-254: 图片路径使用绝对路径，可能在Hugo站点中无法正确加载图片引用使用的绝对路径
/docs/images/toolchain-test-mermaid-2.png在Hugo站点结构中可能无法解析。建议改为相对路径以确保兼容性：<div style="text-align: center;"> - <img src="/docs/images/toolchain-test-mermaid-2.png" alt="HugeGraph工具链测试流程图"> + <img src="../../images/toolchain-test-mermaid-2.png" alt="HugeGraph工具链测试流程图"> </div>
196-196: 语法改进建议LanguageTool提示此处可能表述不够清晰。建议改为：
-在与 `docker-compose.yml` 相同的目录下创建 `./config` 文件夹用于挂载 Hadoop 配置文件。 +在 `docker-compose.yml` 相同的目录下创建 `./config` 文件夹用于挂载 Hadoop 配置文件。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/guides/toolchain-local-test.md(1 hunks)content/en/docs/guides/toolchain-local-test.md(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.28.0)
content/cn/docs/guides/toolchain-local-test.md
[high] 292-293: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
content/en/docs/guides/toolchain-local-test.md
[high] 293-294: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
🪛 LanguageTool
content/cn/docs/guides/toolchain-local-test.md
[uncategorized] ~196-~196: 您的意思是“在"于"”吗？
Context: ... datanode_data: ``` #### Hadoop 配置挂载 在与 docker-compose.yml 相同的目录下创建 `./config...
(YU7_YU8)
content/en/docs/guides/toolchain-local-test.md
[uncategorized] ~443-~443: The official name of this software platform is spelled with a capital “H”.
Context: ...egraph-server/) * CI Script Path: .github/workflows/*-ci.yml (CI configuration f...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/guides/toolchain-local-test.md
55-55: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
68-68: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
78-78: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
342-342: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
350-350: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
content/en/docs/guides/toolchain-local-test.md
55-55: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
68-68: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
78-78: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
343-343: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
351-351: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
|
|
||
| #### 部署步骤 | ||
|
|
||
| **1. 安装 HugeGraph Server** |
There was a problem hiding this comment.
修复Markdown强调误用：应使用标题格式而非加粗文本
根据markdownlint-cli2的MD036规则，这些行应使用适当的Markdown标题而非强调格式。建议修改：
-**1. 安装 HugeGraph Server**
+#### 1. 安装 HugeGraph Server
-**2. 安装可选依赖**
+#### 2. 安装可选依赖
-**3. 健康检查**
+#### 3. 健康检查
-**2. Python 环境**
+#### 2. Python 环境
-**3. 构建并验证**
+#### 3. 构建并验证这样可以改进文档结构和导航。
Also applies to: 68-68, 78-78, 342-342, 350-350
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
55-55: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In content/cn/docs/guides/toolchain-local-test.md around lines 55, 68, 78, 342
and 350, several section labels are incorrectly formatted as bold text instead
of using Markdown headings; change those bolded lines (e.g., "**1. 安装 HugeGraph
Server**") to the appropriate heading syntax (prepend one or more '#' based on
hierarchy, e.g., "## 安装 HugeGraph Server" or "### ..." as appropriate) so they
become real headings, update any numbering inside the heading text if needed,
and ensure spacing (blank lines) before and after each heading to satisfy MD036
and improve document structure and navigation.
| curl http://localhost:8080/graphs # 应返回 {"graphs":["hugegraph"]} | ||
| curl -u admin:pa http://localhost:8080/graphs # 鉴权测试（密码 pa 是测试默认值） |
There was a problem hiding this comment.
curl命令中硬编码了认证密码
Gitleaks检测到curl命令中包含硬编码的基本认证信息。虽然这是测试文档，但出于安全最佳实践考虑，应避免在文档中暴露具体密码。建议改为使用占位符和明确的说明：
-curl -u admin:pa http://localhost:8080/graphs # 鉴权测试（密码 pa 是测试默认值）
+curl -u admin:<password> http://localhost:8080/graphs # 将 <password> 替换为Server启动时设置的密码这样既保留了文档的说明目的，又避免了明文密码的暴露。
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| curl http://localhost:8080/graphs # 应返回 {"graphs":["hugegraph"]} | |
| curl -u admin:pa http://localhost:8080/graphs # 鉴权测试（密码 pa 是测试默认值） | |
| curl http://localhost:8080/graphs # 应返回 {"graphs":["hugegraph"]} | |
| curl -u admin:<password> http://localhost:8080/graphs # 将 <password> 替换为Server启动时设置的密码 |
🧰 Tools
🪛 Gitleaks (8.28.0)
[high] 292-293: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
🤖 Prompt for AI Agents
In content/cn/docs/guides/toolchain-local-test.md around lines 292-293, the curl
example hardcodes a basic-auth password which triggered a secret detection;
replace the literal password with a placeholder (e.g. <username> and <password>
or use $PASSWORD) and update the surrounding text to explain it is a placeholder
or that users should supply their own credentials (optionally via an environment
variable or prompting), ensuring no real passwords appear in the docs.
|
|
||
| #### Deployment Steps | ||
|
|
||
| **1. Install HugeGraph Server** |
There was a problem hiding this comment.
修复Markdown强调误用：应使用标题格式而非加粗文本
根据markdownlint-cli2的MD036规则，这些行应使用适当的Markdown标题而非强调格式。建议修改：
-**1. Install HugeGraph Server**
+#### 1. Install HugeGraph Server
-**2. Install Optional Dependencies**
+#### 2. Install Optional Dependencies
-**3. Health Check**
+#### 3. Health Check
-**2. Python Environment**
+#### 2. Python Environment
-**3. Build and Verify**
+#### 3. Build and Verify这样可以改进文档结构和导航。
Also applies to: 68-68, 78-78, 343-343, 351-351
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
55-55: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In content/en/docs/guides/toolchain-local-test.md at lines 55, 68, 78, 343, and
351, bolded section labels (e.g., "**1. Install HugeGraph Server**") are using
strong emphasis instead of Markdown headings; replace each bolded line with the
appropriate Markdown heading (e.g., "## 1. Install HugeGraph Server" or "###"
level matching the document structure) so they become real section headings and
update any surrounding heading levels for consistency.
| curl http://localhost:8080/graphs # Should return {"graphs":["hugegraph"]} | ||
| curl -u admin:pa http://localhost:8080/graphs # Authentication test (pa is test default password) |
There was a problem hiding this comment.
curl命令中硬编码了认证密码
Gitleaks检测到curl命令中包含硬编码的基本认证信息。虽然这是测试文档，但出于安全最佳实践考虑，应避免在文档中暴露具体密码。建议改为使用占位符和明确的说明：
-curl -u admin:pa http://localhost:8080/graphs # Authentication test (pa is test default password)
+curl -u admin:<password> http://localhost:8080/graphs # Replace <password> with the password set during server setup这样既保留了文档的说明目的，又避免了明文密码的暴露。
🧰 Tools
🪛 Gitleaks (8.28.0)
[high] 293-294: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
🤖 Prompt for AI Agents
In content/en/docs/guides/toolchain-local-test.md around lines 293 to 294, the
curl example contains a hard-coded basic auth password which Gitleaks flags;
replace the explicit password with a placeholder (e.g., -u admin:<PASSWORD>) and
add a short note telling readers to substitute their own password or use an
environment variable or credential manager for tests, so the example
demonstrates authentication without exposing real credentials.
2 participants
This PR aims to address the issue raised in apache/incubator-hugegraph-toolchain issue #618, which is to provide detailed documentation for developers on how to run HugeGraph-Toolchain tests locally.
This PR is related to apache/incubator-hugegraph-toolchain issue #618.
Summary by CodeRabbit
文档
Chore