docs: add toplingdb related docs & enable blog module#12
docs: add toplingdb related docs & enable blog module#12syslucas wants to merge 15 commits intohugegraph:masterfrom
Conversation
|
@codecov-ai-reviewer review |
Summary of ChangesHello @gy-deng, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the HugeGraph documentation by introducing comprehensive guides for integrating and configuring ToplingDB, an extended version of RocksDB. It also revitalizes the project's blog section, making it visible and adding new categories to cover various aspects of HugeGraph. Furthermore, the PR improves the website's performance and privacy by switching to self-hosted fonts and updates documentation examples to promote better security practices by using generic password placeholders. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
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将主菜单项“Blog”替换为“Blog Posts”并改为站内链接；新增并重组中英文博客分类（HugeGraph、HugeGraph-AI、Computing、ToolChain、ToplingDB），添加 ToplingDB 配置与快速上手文档；删除示例 News/Releases 页面；在配置与贡献指南中加入 ToplingDB/RocksDB 选项与环境说明，并重排 quickstart 后端章节与锚点。 Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as 开发者/运维
participant Config as 配置文件 (config.toml)
participant Docs as 文档站点
participant Topling as ToplingDB 服务
rect rgba(0,128,96,0.08)
Dev->>Config: 更新主菜单为 /blog/ (Blog Posts)
Dev->>Docs: 添加/更新博客分类与 ToplingDB 文档
end
rect rgba(0,102,204,0.06)
Dev->>Topling: 运行 preload-topling.sh（提取库/资源）
Dev->>Topling: 设置 LD_LIBRARY_PATH / LD_PRELOAD
Topling-->>Dev: Web UI / 日志 验证
end
Note over Docs,Topling: 文档引导配置 -> 预加载 -> 启动 -> 验证
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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 |
![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 pull request introduces documentation for ToplingDB and enables the blog module. The changes are primarily focused on documentation and configuration files. I've identified a few areas for improvement to enhance clarity and consistency. These include resolving inconsistencies in library names for LD_PRELOAD, clarifying docker-compose.yml examples, and aligning section numbering between the Chinese and English documentation. Additionally, there's a minor copy-paste error in one of the new blog posts. Overall, these changes add valuable new documentation to the project.
content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md
Outdated
Show resolved
Hide resolved
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md
Outdated
Show resolved
Hide resolved
content/cn/blog/hugegraph/ToplingDB/ToplingDB Configuration YAML.md
Outdated
Show resolved
Hide resolved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (40)
assets/fonts/OpenSans-Bold.woffis excluded by!**/*.woffassets/fonts/OpenSans-Bold.woff2is excluded by!**/*.woff2assets/fonts/OpenSans-BoldItalic.woffis excluded by!**/*.woffassets/fonts/OpenSans-BoldItalic.woff2is excluded by!**/*.woff2assets/fonts/OpenSans-Italic.woffis excluded by!**/*.woffassets/fonts/OpenSans-Italic.woff2is excluded by!**/*.woff2assets/fonts/OpenSans-Light.woffis excluded by!**/*.woffassets/fonts/OpenSans-Light.woff2is excluded by!**/*.woff2assets/fonts/OpenSans-LightItalic.woffis excluded by!**/*.woffassets/fonts/OpenSans-LightItalic.woff2is excluded by!**/*.woff2assets/fonts/OpenSans-Regular.woffis excluded by!**/*.woffassets/fonts/OpenSans-Regular.woff2is excluded by!**/*.woff2assets/fonts/Rubik-Bold.woffis excluded by!**/*.woffassets/fonts/Rubik-Bold.woff2is excluded by!**/*.woff2assets/fonts/Rubik-Light.woffis excluded by!**/*.woffassets/fonts/Rubik-Light.woff2is excluded by!**/*.woff2assets/fonts/Rubik-Medium.woffis excluded by!**/*.woffassets/fonts/Rubik-Medium.woff2is excluded by!**/*.woff2assets/fonts/Rubik-Regular.woffis excluded by!**/*.woffassets/fonts/Rubik-Regular.woff2is excluded by!**/*.woff2assets/fonts/Rubik-SemiBold.woffis excluded by!**/*.woffassets/fonts/Rubik-SemiBold.woff2is excluded by!**/*.woff2assets/fonts/Tajawal-Bold.woffis excluded by!**/*.woffassets/fonts/Tajawal-Bold.woff2is excluded by!**/*.woff2assets/fonts/Tajawal-Light.woffis excluded by!**/*.woffassets/fonts/Tajawal-Light.woff2is excluded by!**/*.woff2assets/fonts/Tajawal-Medium.woffis excluded by!**/*.woffassets/fonts/Tajawal-Medium.woff2is excluded by!**/*.woff2assets/fonts/Tajawal-Regular.woffis excluded by!**/*.woffassets/fonts/Tajawal-Regular.woff2is excluded by!**/*.woff2assets/fonts/Vazir-Bold.woffis excluded by!**/*.woffassets/fonts/Vazir-Bold.woff2is excluded by!**/*.woff2assets/fonts/Vazir-Light.woffis excluded by!**/*.woffassets/fonts/Vazir-Light.woff2is excluded by!**/*.woff2assets/fonts/Vazir-Medium.woffis excluded by!**/*.woffassets/fonts/Vazir-Medium.woff2is excluded by!**/*.woff2assets/fonts/Vazir-Regular.woffis excluded by!**/*.woffassets/fonts/Vazir-Regular.woff2is excluded by!**/*.woff2content/cn/blog/news/first-post/featured-sunset-get.pngis excluded by!**/*.pngcontent/en/blog/news/first-post/featured-sunset-get.pngis excluded by!**/*.png
📒 Files selected for processing (43)
assets/scss/_variables_project.scss(1 hunks)config.toml(1 hunks)content/cn/blog/_index.md(1 hunks)content/cn/blog/computing/_index.md(1 hunks)content/cn/blog/hugegraph-ai/_index.md(1 hunks)content/cn/blog/hugegraph/ToplingDB/ToplingDB Configuration YAML.md(1 hunks)content/cn/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md(1 hunks)content/cn/blog/hugegraph/ToplingDB/_index.md(1 hunks)content/cn/blog/hugegraph/_index.md(1 hunks)content/cn/blog/news/_index.md(0 hunks)content/cn/blog/news/first-post/index.md(0 hunks)content/cn/blog/news/second-post.md(0 hunks)content/cn/blog/releases/_index.md(0 hunks)content/cn/blog/releases/in-depth-monoliths-detailed-spec.md(0 hunks)content/cn/blog/toolchain/_index.md(1 hunks)content/cn/docs/config/config-authentication.md(2 hunks)content/cn/docs/config/config-guide.md(1 hunks)content/cn/docs/config/config-option.md(1 hunks)content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(9 hunks)content/cn/docs/quickstart/toolchain/hugegraph-hubble.md(1 hunks)content/cn/docs/quickstart/toolchain/hugegraph-loader.md(1 hunks)content/en/blog/_index.md(1 hunks)content/en/blog/computing/_index.md(1 hunks)content/en/blog/hugegraph-ai/_index.md(1 hunks)content/en/blog/hugegraph/ToplingDB/ToplingDB Configuration YAML.md(1 hunks)content/en/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md(1 hunks)content/en/blog/hugegraph/ToplingDB/_index.md(1 hunks)content/en/blog/hugegraph/_index.md(1 hunks)content/en/blog/news/_index.md(0 hunks)content/en/blog/news/first-post/index.md(0 hunks)content/en/blog/news/second-post.md(0 hunks)content/en/blog/releases/_index.md(0 hunks)content/en/blog/releases/in-depth-monoliths-detailed-spec.md(0 hunks)content/en/blog/toolchain/_index.md(1 hunks)content/en/docs/config/config-authentication.md(2 hunks)content/en/docs/config/config-guide.md(1 hunks)content/en/docs/config/config-option.md(1 hunks)content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(7 hunks)content/en/docs/quickstart/toolchain/hugegraph-hubble.md(1 hunks)themes/docsy/assets/scss/_variables.scss(2 hunks)themes/docsy/assets/scss/rtl/_main.scss(1 hunks)
💤 Files with no reviewable changes (10)
- content/cn/blog/releases/_index.md
- content/en/blog/releases/in-depth-monoliths-detailed-spec.md
- content/en/blog/news/_index.md
- content/cn/blog/releases/in-depth-monoliths-detailed-spec.md
- content/cn/blog/news/first-post/index.md
- content/en/blog/news/first-post/index.md
- content/cn/blog/news/second-post.md
- content/cn/blog/news/_index.md
- content/en/blog/news/second-post.md
- content/en/blog/releases/_index.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md
57-57: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md
57-57: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
content/cn/docs/quickstart/hugegraph/hugegraph-server.md
318-318: Hard tabs
Column: 12
(MD010, no-hard-tabs)
319-319: Hard tabs
Column: 3
(MD010, no-hard-tabs)
320-320: Hard tabs
Column: 3
(MD010, no-hard-tabs)
363-363: Hard tabs
Column: 12
(MD010, no-hard-tabs)
492-492: Hard tabs
Column: 3
(MD010, no-hard-tabs)
content/en/docs/quickstart/hugegraph/hugegraph-server.md
49-49: Link fragments should be valid
(MD051, link-fragments)
content/cn/docs/config/config-option.md
188-188: Hard tabs
Column: 9
(MD010, no-hard-tabs)
189-189: Hard tabs
Column: 12
(MD010, no-hard-tabs)
🔇 Additional comments (1)
content/cn/docs/quickstart/toolchain/hugegraph-hubble.md (1)
68-69: 环境变量示例更新准确新增
PASSWORD=xxx使 docker-compose 示例与最新认证配置保持一致，方便用户直接对接新版镜像。
content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md
Outdated
Show resolved
Hide resolved
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (1)
574-578: 修复错误的段内锚点编号（3.3 → 3.1）此处链接文本与锚点均指向“3.3”，但本文实际为“3.1 Use Docker container”。请同步更正以避免跳转失败。
-In [3.3 Use Docker container](#33-use-docker-container), we have introduced how to use docker to deploy `hugegraph-server`. `server` can also preload an example graph by setting the parameter. +In [3.1 Use Docker container](#31-use-docker-container), we have introduced how to use docker to deploy `hugegraph-server`. `server` can also preload an example graph by setting the parameter.
♻️ Duplicate comments (1)
content/cn/blog/hugegraph/ToplingDB/ToplingDB Configuration YAML.md (1)
154-155: 重复标注问题已消除，LGTM先前反馈的
memtable_as_log_index: true #重复已修复，当前表述清晰。
🧹 Nitpick comments (1)
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md (1)
56-58: LD_PRELOAD 用法说明补充操作系统限制（可选）此处示例清晰，缩进已符合 markdownlint。为避免误导 macOS 用户，建议备注“LD_PRELOAD 适用于 Linux；macOS 通常使用 DYLD_INSERT_LIBRARIES（且受 SIP 限制）”。不影响主要读者可按需忽略。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
content/cn/blog/hugegraph/ToplingDB/ToplingDB Configuration YAML.md(1 hunks)content/cn/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md(1 hunks)content/cn/docs/config/config-option.md(2 hunks)content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(7 hunks)content/en/blog/hugegraph/ToplingDB/ToplingDB Configuration YAML.md(1 hunks)content/en/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md(1 hunks)content/en/docs/config/config-option.md(2 hunks)content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(5 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
- content/cn/docs/config/config-option.md
- content/en/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md
- content/cn/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md
- content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md
🔇 Additional comments (1)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (1)
49-51: 内链引用与锚点已对齐，LGTM已更新为 5.1.9 且锚点使用小写 slug，点击可达。
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (1)
49-50: 锚点与章节编号已纠正，👍 请同步中文页并做一次站内校验
- 5.1.9 的段内锚点与链接文本已对齐；认证章节锚点大小写/拼写也已修复。建议同步检查中文文档对应编号是否一致。
请运行以下只读脚本做一次仓库内校验（确认锚点与目标标题存在，且无遗留旧锚点用法）：
#!/bin/bash set -euo pipefail echo "1) 校验本页 5.1.9 标题是否存在：" rg -nP '^\s*#####\s+5\.1\.9\s+Create an example graph when startup' content/en/docs/quickstart/hugegraph/hugegraph-server.md || true echo -e "\n2) 校验目标认证文档与标题是否存在：" fd -a 'config-authentication.*\.md' content | while read -r f; do echo "==> $f" rg -n '^\s*#+\s*Use docker to enable authentication mode' "$f" || true done echo -e "\n3) 搜索仓库内是否仍存在旧锚点：" rg -nP '#517-create-an-example-graph-when-startup|Use-docker-to-enble-authentication-mode' || true
🧹 Nitpick comments (2)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (2)
508-552: MySQL 小节可补充 URL 含数据库名的等价写法，降低踩坑概率（可选）多数用户习惯在 JDBC URL 中直接带库名。建议在现有基于
store的配置外，补充一个“等价”的 URL 示例，并说明二者取其一即可，避免重复配置引起疑惑。可在“Update hugegraph.properties”后追加一段说明与示例：
jdbc.url=jdbc:mysql://127.0.0.1:3306 jdbc.username= jdbc.password= jdbc.reconnect_max_times=3 jdbc.reconnect_interval=3 jdbc.ssl_mode=false + +# Alternative: you can also specify database name in JDBC URL (use either this or `store`, not both) +# jdbc.url=jdbc:mysql://127.0.0.1:3306/hugegraph +# store=hugegraph
353-361: 补充 ToplingDB 最小可用配置与初始化步骤
当前仅引用博客，与其他后端节“就地可用”程度不一致，建议在此处直接提供示例配置与一次性初始化命令，并保留 Ref 链接，示例：##### 5.1.4 ToplingDB <details> <summary>Click to expand/collapse ToplingDB configuration and startup methods</summary> -Ref: [ToplingDB Quick Start]({{< ref path="/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md" lang="en">}}) +Minimal configuration (示例): + +```properties +backend=rocksdb +serializer=binary +rocksdb.data_path=. +rocksdb.wal_path=. +# ToplingDB 可选项，按需调整 +rocksdb.option_path=/path/to/toplingdb/hg-rocksdb.ini +rocksdb.open_http=true +``` + +初始化（仅首次）: +```bash +cd hugegraph-${version} +bin/init-store.sh +``` + +启动服务: +```bash +bin/start-hugegraph.sh +``` + +Ref: [ToplingDB Quick Start]({{< ref path="/blog/hugegraph/ToplingDB/ToplingDB Quick Start.md" lang="en">}}) </details>已确认 Ref 路径有效，无需调整。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
content/cn/docs/config/config-option.md(2 hunks)content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(8 hunks)content/en/docs/config/config-option.md(2 hunks)content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(6 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- content/en/docs/config/config-option.md
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
🔇 Additional comments (3)
content/cn/docs/config/config-option.md (2)
64-72: 表格对齐更新正常本段格式清晰，正则转义保留正确，未发现问题。
188-189: 新增 ToplingDB 配置项描述完整新增说明覆盖默认行为与安全注意事项，表格布局也规范，👍。
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md (1)
56-58: Fix the LD_PRELOAD separator
LD_PRELOADexpects libraries separated by spaces; the current colon-delimited example is interpreted as a single (invalid) filename and the preload fails at runtime.建议修改如下：
-- RocksDB Plus requires preloading dynamic libraries via the `LD_PRELOAD` mechanism. Developers need to set two environment variables: `LD_LIBRARY_PATH` should point to the `library` directory extracted by `preload-topling.sh`, and `LD_PRELOAD` should be set to `libjemalloc.so:librocksdbjni-linux64.so` to ensure the necessary libraries are correctly loaded at runtime. +- RocksDB Plus requires preloading dynamic libraries via the `LD_PRELOAD` mechanism. Developers need to set two environment variables: `LD_LIBRARY_PATH` should point to the `library` directory extracted by `preload-topling.sh`, and `LD_PRELOAD` should be set to `libjemalloc.so librocksdbjni-linux64.so` to ensure the necessary libraries are correctly loaded at runtime. - LD_LIBRARY_PATH=/path/to/your/library:$LD_LIBRARY_PATH - - LD_PRELOAD=libjemalloc.so:librocksdbjni-linux64.so + - LD_PRELOAD="libjemalloc.so librocksdbjni-linux64.so"Likely an incorrect or invalid review comment.
content/cn/docs/contribution-guidelines/hugegraph-server-idea-setup.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (2)
78-78: 修正重复的版本示例“1.5.0/1.5.0” 重复，建议改为稳定/次要版本占位。
- 2. Recommend to use `release tag`(like `1.5.0`/`1.5.0`) for the stable version. Use `latest` tag to experience the newest functions in development. + 2. Recommend to use a specific release tag (e.g., `1.5.0` or `1.x.0`) for stability. Use `latest` to try the newest features in development.
80-80: 拼写修正：重复单词“Download the binary tar tarball” → “Download the binary tarball”
-#### 3.2 Download the binary tar tarball +#### 3.2 Download the binary tarballcontent/cn/docs/quickstart/hugegraph/hugegraph-server.md (1)
616-620: 拼写错误与变量前缀说明“hugegrpah.” 拼写错误，应为 “hugegraph.”。
-我们需要在这些配置项前加上 `hugegrpah.`，即 `hugegraph.backend` 和 `hugegraph.cassandra.host`。 +我们需要在这些配置项前加上 `hugegraph.`，即 `hugegraph.backend` 和 `hugegraph.cassandra.host`。
♻️ Duplicate comments (1)
content/cn/docs/quickstart/hugegraph/hugegraph-server.md (1)
313-320: 去除制表符（MD010）并与英文标题一致性检查
- 请将该折叠块内的所有制表符替换为空格，确保通过 markdownlint（MD010）。
- 同时英文页未标注“(Beta)”，建议两端一致（统一是否标注 Beta）。
🧹 Nitpick comments (8)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (3)
66-69: 优化 docker-compose environment 写法与文案
- 合并为内联注释更清晰；同时更正英文语法（an option、built‑in）。
environment: - - PASSWORD=xxx - # PASSWORD is an option to enable auth mode with the password you set. - # - PRELOAD=true - # PRELOAD is a option to preload a build-in sample graph when initializing. + - PASSWORD=xxx # Enable auth mode and set admin password + # - PRELOAD=true # Preload a built-in sample graph on initialization
353-361: ToplingDB 标题标注与中英文一致性中文页为“ToplingDB (Beta)”，此处为“ToplingDB”。建议两边一致（要么都标注 Beta，要么都去掉）。
578-578: 标题措辞微调“Uses Cassandra as storage” 建议改为 “Use Cassandra as storage”。
-##### 5.2.1 Uses Cassandra as storage +##### 5.2.1 Use Cassandra as storagecontent/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
20-21: 统一 document_root 示例路径并强化生产安全提示示例建议用可替换占位路径，避免与其他文档不一致；并补一行“生产限制访问”的提示（尽管下文已有安全节，这里就近提醒更直观）。
- document_root: /dev/shm/rocksdb_resource # Static resource directory, extracted by `preload_topling.sh` in HugeGraph + document_root: path-to-your-directory/library/rocksdb_resource # Extracted by `preload-topling.sh` (adjust to your env; restrict access in production)
203-205: 英语措辞：避免双情态结构“only needs reserved virtual address space” → “only needs to reserve virtual address space” 更地道。
-while CSPP only needs reserved virtual address space. +while CSPP only needs to reserve virtual address space.content/cn/docs/quickstart/hugegraph/hugegraph-server.md (2)
65-69: 优化 environment 示例与中文注释合并为内联注释更直观；同时统一注释风格。
environment: - - PASSWORD=xxx - # - PASSWORD=xxx 为可选参数，设置的时候可以开启鉴权模式，并设置密码 - # - PRELOAD=true - # - PRELOAD=true 为可选参数，为 True 时可以在启动的时候预加载一个内置的样例图 + - PASSWORD=xxx # 可选，设置后开启鉴权模式并指定 admin 密码 + # - PRELOAD=true # 可选，启动时预加载内置样例图
313-313: 中英文文档小节顺序/编号对齐当前中文为 5.1.3 ToplingDB → 5.1.4 HBase → 5.1.5 MySQL → 5.1.6 Cassandra → 5.1.7 Memory → 5.1.8 ScyllaDB；英文为 5.1.4 ToplingDB → 5.1.5 Cassandra → 5.1.6 ScyllaDB → 5.1.7 HBase → 5.1.8 MySQL。建议统一顺序与编号，便于跨语言查阅。
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (1)
28-29: 统一 document_root 示例路径与脚本名，并补充安全提示与其他文档保持一致，使用可替换占位路径；脚本名统一为
preload-topling.sh。- document_root: /dev/shm/rocksdb_resource # 静态资源目录, HugeGraph中通过`preload_topling.sh`进行静态资源提取 + document_root: path-to-your-directory/library/rocksdb_resource # 静态资源目录，`preload-topling.sh` 解压生成（生产环境请限制访问）
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
content/cn/blog/images/images-server/toplingdb-web-server.pngis excluded by!**/*.pngcontent/cn/blog/images/images-server/toplingdb-yaml-ref.pngis excluded by!**/*.pngcontent/en/blog/images/images-server/toplingdb-web-server.pngis excluded by!**/*.pngcontent/en/blog/images/images-server/toplingdb-yaml-ref.pngis excluded by!**/*.png
📒 Files selected for processing (14)
config.toml(1 hunks)content/cn/blog/_index.md(1 hunks)content/cn/blog/hugegraph-ai/_index.md(1 hunks)content/cn/blog/hugegraph/toplingdb/_index.md(1 hunks)content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/cn/blog/hugegraph/toplingdb/toplingdb-quick-start.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(8 hunks)content/en/blog/_index.md(1 hunks)content/en/blog/hugegraph-ai/_index.md(1 hunks)content/en/blog/hugegraph/toplingdb/_index.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md(1 hunks)content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md(3 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(6 hunks)
✅ Files skipped from review due to trivial changes (1)
- content/cn/blog/hugegraph/toplingdb/toplingdb-quick-start.md
🧰 Additional context used
🪛 LanguageTool
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[uncategorized] ~260-~260: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：灵活"地"统计
Context: ...tcherTable 支持多工厂调度 - 内置 Web Server - 更灵活的统计与观测控制 - 特殊 DBOptions（如 memtable_as_log...
(wb4)
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md
[grammar] ~57-~57: There might be a mistake here.
Context: ...H=/path/to/your/library:$LD_LIBRARY_PATH - LD_PRELOAD=libjemalloc.so:librocksdbjni-...
(QB_NEW_EN)
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[style] ~203-~203: The double modal “needs reserved” is nonstandard (only accepted in certain dialects). Consider “to be reserved”.
Context: ...th mapped pages), while CSPP only needs reserved virtual address space. When use_vm ...
(NEEDS_FIXED)
[grammar] ~243-~243: There might be a mistake here.
Context: ...ingDB and do not include authentication. - By default, `listening_ports: '127.0.0.1...
(QB_NEW_EN)
[grammar] ~250-~250: There might be a mistake here.
Context: ...esource` uses a shared memory directory. - In multi-user environments, ensure prope...
(QB_NEW_EN)
[grammar] ~257-~257: There might be a mistake here.
Context: ...gin-based configuration and object reuse - A new MemTable type (cspp) with a paired...
(QB_NEW_EN)
[grammar] ~258-~258: There might be a mistake here.
Context: ...e type (cspp) with a paired TableFactory - DispatcherTable for multi-factory schedu...
(QB_NEW_EN)
[grammar] ~259-~259: There might be a mistake here.
Context: ...atcherTable for multi-factory scheduling - Built-in Web Server - More flexible stat...
(QB_NEW_EN)
[grammar] ~260-~260: There might be a mistake here.
Context: ...multi-factory scheduling - Built-in Web Server - More flexible statistics and observabili...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ...le statistics and observability controls - Special DBOptions (such as `memtable_as_...
(QB_NEW_EN)
content/cn/blog/hugegraph-ai/_index.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- title: "HugeGraph-AI" linkTitle: "HugeGraph-AI" weight: 3 ---
(QB_NEW_DE)
content/cn/blog/hugegraph/toplingdb/_index.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- title: "ToplingDB" linkTitle: "ToplingDB" weight: 1 ---
(QB_NEW_DE)
content/en/blog/_index.md
[grammar] ~9-~9: There might be a mistake here.
Context: ...nu: main: weight: 30 --- Welcome to HugeGraph Blog! Here you will find tec...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ... optimization, storage engines, and more - HugeGraph-AI: Application cases combin...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ... cases combining AI with graph computing - HugeGraph Computing (OLAP): Large-scal...
(QB_NEW_EN)
content/en/blog/hugegraph-ai/_index.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- title: "HugeGraph-AI" linkTitle: "HugeGraph-AI" weight: 3 ---
(QB_NEW_DE)
content/en/blog/hugegraph/toplingdb/_index.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- title: "ToplingDB" linkTitle: "ToplingDB" weight: 1 ---
(QB_NEW_DE)
content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md
[grammar] ~116-~116: There might be a mistake here.
Context: ...s**: 1. Check if the port is occupied: lsof -i :2011 2. Modify listening_ports in the YAML fil...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ons**: 1. Confirm correct config path: rocksdb.option_path=./conf/graphs/rocksdb_plus.yaml 2. Check data directory permissions: ensure...
(QB_NEW_EN)
🔇 Additional comments (1)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (1)
49-50: 锚点与片段大小写已修复，LGTM。请同步检查中文文档编号对齐此处已更正为有效锚点和小写片段，跳转正常。建议再全局检索，确保中文版本的对应小节编号/锚点也保持一致，避免跨语言跳转不一致。
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
Outdated
Show resolved
Hide resolved
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
Outdated
Show resolved
Hide resolved
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
Outdated
Show resolved
Hide resolved
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
Outdated
Show resolved
Hide resolved
content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (6)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (3)
3-5: Front matter 标题语言不一致中文页面的 title 建议使用中文，保持与 linkTitle 一致。
-title: "ToplingDB YAML configuration file" +title: "ToplingDB 的 YAML 配置文件"
252-266: 章节编号重复（两个 6）并顺延“相关文档”请顺延编号，避免锚点/目录混乱。
-## 6. 总结 +## 7. 总结 ... -## 相关文档 +## 8. 相关文档
28-30: 统一 document_root 示例路径并补充生产安全提示与“IDEA 本地调试指南”一致，建议用 library/rocksdb_resource（或注明按环境调整），并提示生产需限制访问。
- document_root: /dev/shm/rocksdb_resource # 静态资源目录, HugeGraph中通过`preload_topling.sh`进行静态资源提取 - listening_ports: '127.0.0.1:2011' # Web Server监听端口，用于管理/监控 如端口被占用，请改为其他端口，例如 2012 或 2013 + document_root: path-to-your-directory/library/rocksdb_resource # 静态资源目录，`preload-topling.sh` 解压生成（按部署环境调整；生产请限制访问） + listening_ports: '127.0.0.1:2011' # 仅本机访问；生产环境请通过防火墙/反代限制暴露端口（占用则改为 2012/2013 等）content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
253-266: 章节编号重复（两个 6），需顺延并保持锚点一致将 “Summary” 改为 7，“Related Documentation” 改为 8。
-## 6. Summary +## 7. Summary ... -## Related Documentation +## 8. Related Documentation
20-22: 统一 http.document_root 示例路径并补充生产安全提示与 IDEA 指南一致，建议使用 library/rocksdb_resource（或注明按环境调整），并增加生产限制访问说明。
- document_root: /dev/shm/rocksdb_resource # Static resource directory, extracted by `preload_topling.sh` in HugeGraph + document_root: path-to-your-directory/library/rocksdb_resource # Extracted by `preload-topling.sh` (adjust to your env; restrict access in production) - listening_ports: '127.0.0.1:2011' # Web Server listening port for management/monitoring + listening_ports: '127.0.0.1:2011' # Localhost only; restrict exposure via firewall/reverse proxy in productioncontent/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md (1)
74-76: 修正日志文件扩展名拼写，避免命令失败应为 .log，否则会 “No such file or directory”。
-tail -f logs/hugegraph-server.lgo | grep -i topling +tail -f logs/hugegraph-server.log | grep -i topling
🧹 Nitpick comments (2)
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
203-206: 英文表述小幅润色以避免 double modal将 “needs reserved” 调整为更自然的表达。
-while CSPP only needs reserved virtual address space. +while CSPP only needs to reserve virtual address space.
153-155: 注释小语法优化“must be false to hugegraph” 建议改为 “for HugeGraph”。
- create_missing_column_families: false # this is important, must be false to hugegraph + create_missing_column_families: false # important: must be false for HugeGraph
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/cn/blog/hugegraph/toplingdb/toplingdb-quick-start.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- content/cn/blog/hugegraph/toplingdb/toplingdb-quick-start.md
🧰 Additional context used
🪛 LanguageTool
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[style] ~203-~203: The double modal “needs reserved” is nonstandard (only accepted in certain dialects). Consider “to be reserved”.
Context: ...th mapped pages), while CSPP only needs reserved virtual address space. When use_vm ...
(NEEDS_FIXED)
[grammar] ~243-~243: There might be a mistake here.
Context: ...ingDB and do not include authentication. - By default, `listening_ports: '127.0.0.1...
(QB_NEW_EN)
[grammar] ~250-~250: There might be a mistake here.
Context: ...esource` uses a shared memory directory. - In multi-user environments, ensure prope...
(QB_NEW_EN)
[grammar] ~257-~257: There might be a mistake here.
Context: ...gin-based configuration and object reuse - A new MemTable type (cspp) with a paired...
(QB_NEW_EN)
[grammar] ~258-~258: There might be a mistake here.
Context: ...e type (cspp) with a paired TableFactory - DispatcherTable for multi-factory schedu...
(QB_NEW_EN)
[grammar] ~259-~259: There might be a mistake here.
Context: ...atcherTable for multi-factory scheduling - Built-in Web Server - More flexible stat...
(QB_NEW_EN)
[grammar] ~260-~260: There might be a mistake here.
Context: ...multi-factory scheduling - Built-in Web Server - More flexible statistics and observabili...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ...le statistics and observability controls - Special DBOptions (such as `memtable_as_...
(QB_NEW_EN)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[uncategorized] ~260-~260: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：灵活"地"统计
Context: ...tcherTable 支持多工厂调度 - 内置 Web Server - 更灵活的统计与观测控制 - 特殊 DBOptions（如 memtable_as_log...
(wb4)
content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md
[grammar] ~116-~116: There might be a mistake here.
Context: ...s**: 1. Check if the port is occupied: lsof -i :2011 2. Modify listening_ports in the YAML fil...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ons**: 1. Confirm correct config path: rocksdb.option_path=./conf/graphs/rocksdb_plus.yaml 2. Check data directory permissions: ensure...
(QB_NEW_EN)
🔇 Additional comments (4)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
119-120: 核对 level_writers 项数量是否与层级匹配当前为 6 个条目。若集群层级为 L0–L6，可能需要 7 个。请确认 SidePlugin 的期望长度，避免越界或回退默认。
28-28: 脚本名下划线/连字符不一致此处为 preload_topling.sh，而其它文档为 preload-topling.sh。请统一并与仓库实际脚本名一致。
- document_root: path-to-your-directory/library/rocksdb_resource # 静态资源目录，`preload-topling.sh` 解压生成（按部署环境调整；生产请限制访问） + document_root: path-to-your-directory/library/rocksdb_resource # 静态资源目录，`preload-topling.sh` 或 `preload_topling.sh` 解压（以实际脚本为准）content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
112-120: 核对 level_writers 数组长度是否符合预期层级当前提供 6 个。若包含 L0–L6，可能需 7 个。请核实 SidePlugin 的要求，防止配置被忽略或回退默认。
20-20: 脚本名一致性核对此处为 preload_topling.sh，其他位置出现 preload-topling.sh。请统一为实际脚本名。
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (1)
20-22: 统一 document_root 示例路径并补充生产安全提示（与其他文档一致）示例使用 /dev/shm/rocksdb_resource 易引发困惑；建议改为可移植的 library 路径占位，并提醒生产限制访问。
- document_root: /dev/shm/rocksdb_resource # Static resource directory, extracted by `preload_topling.sh` in HugeGraph + document_root: path-to-your-directory/library/rocksdb_resource # Extracted by `preload-topling.sh` (adjust to your env; restrict access in production)content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
3-5: Front matter 标题与语言统一中文页面建议使用中文标题，和 linkTitle 一致。
-title: "ToplingDB YAML configuration file" +title: "ToplingDB 的 YAML 配置文件"
28-30: 统一 document_root 示例路径并加入访问安全提示与其他文档一致，使用可移植的 library 目录占位，并提醒生产限制访问。
- document_root: /dev/shm/rocksdb_resource # 静态资源目录, HugeGraph中通过`preload_topling.sh`进行静态资源提取 + document_root: path-to-your-directory/library/rocksdb_resource # `preload-topling.sh` 解压生成（按环境调整；生产请限制访问）
🧹 Nitpick comments (4)
content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md (2)
26-28: 避免通配符导致误匹配，建议使用明确目录名通配符可能在存在多个匹配目录时误跳转。建议改为明确的目录名或示例占位。
-cd *hugegraph-${version} +cd hugegraph-${version} # 或替换为你的解压目录名
99-102: 补充 PyYAML 依赖提示，确保校验命令可用直接运行 python -c 中的 yaml.safe_load 需已安装 PyYAML，否则会失败。
-1. Check YAML indentation (must use spaces, not tabs) -2. Validate YAML syntax: `python -c "import yaml; yaml.safe_load(open('conf/graphs/rocksdb_plus.yaml'))"` -3. Review specific error messages in logs +1. Check YAML indentation (must use spaces, not tabs) +2. Install PyYAML: `pip install pyyaml` +3. Validate YAML syntax: `python -c "import yaml; yaml.safe_load(open('conf/graphs/rocksdb_plus.yaml'))"` +4. Review specific error messages in logscontent/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (1)
203-205: 小幅措辞调整，避免 “needs reserved” 非标准表达提升可读性。
-while CSPP only needs reserved virtual address space. +while CSPP only needs to reserve virtual address space.content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (1)
202-205: 修正表述小瑕疵与错别字提高可读性与准确性。
-在使用 malloc/posix_memalign 分配内存时，地址空间可能是已经实际分配的（位于堆空间中，已有对应的物理页面），而 CSPP 在分配时只需要获得保留的地址空间。 -`use_vm` 选项为 `true` 时会强制使用 `mmap` 分配内存，从而保证分配的一定时是保留地址空间，但并不实际占用物理页面。 -`use_vm` 默认值为 `true`。如果用户物理内存空间充足，建议关闭此选项，`mmap` 分配的虚拟内存空间在建立对物理地址的映射时会触发大量minor page fault，可能会影响性能。 +在使用 malloc/posix_memalign 分配内存时，地址空间可能已实际分配（位于堆空间并映射物理页），而 CSPP 仅需保留的虚拟地址空间。 +`use_vm` 为 `true` 时强制使用 `mmap` 分配，保证分配的一定是保留的地址空间，而不实际占用物理页面。 +`use_vm` 默认值为 `true`。若物理内存充足，建议关闭此选项；`mmap` 的虚拟内存在建立物理映射时会触发较多次缺页（minor page fault），可能影响性能。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/cn/blog/hugegraph/toplingdb/toplingdb-quick-start.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- content/cn/blog/hugegraph/toplingdb/toplingdb-quick-start.md
🧰 Additional context used
🪛 LanguageTool
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[style] ~203-~203: The double modal “needs reserved” is nonstandard (only accepted in certain dialects). Consider “to be reserved”.
Context: ...th mapped pages), while CSPP only needs reserved virtual address space. When use_vm ...
(NEEDS_FIXED)
[grammar] ~243-~243: There might be a mistake here.
Context: ...ingDB and do not include authentication. - By default, `listening_ports: '127.0.0.1...
(QB_NEW_EN)
[grammar] ~250-~250: There might be a mistake here.
Context: ...esource` uses a shared memory directory. - In multi-user environments, ensure prope...
(QB_NEW_EN)
[grammar] ~257-~257: There might be a mistake here.
Context: ...gin-based configuration and object reuse - A new MemTable type (cspp) with a paired...
(QB_NEW_EN)
[grammar] ~258-~258: There might be a mistake here.
Context: ...e type (cspp) with a paired TableFactory - DispatcherTable for multi-factory schedu...
(QB_NEW_EN)
[grammar] ~259-~259: There might be a mistake here.
Context: ...atcherTable for multi-factory scheduling - Built-in Web Server - More flexible stat...
(QB_NEW_EN)
[grammar] ~260-~260: There might be a mistake here.
Context: ...multi-factory scheduling - Built-in Web Server - More flexible statistics and observabili...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ...le statistics and observability controls - Special DBOptions (such as `memtable_as_...
(QB_NEW_EN)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[uncategorized] ~260-~260: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：灵活"地"统计
Context: ...tcherTable 支持多工厂调度 - 内置 Web Server - 更灵活的统计与观测控制 - 特殊 DBOptions（如 memtable_as_log...
(wb4)
content/en/blog/hugegraph/toplingdb/toplingdb-quick-start.md
[grammar] ~116-~116: There might be a mistake here.
Context: ...s**: 1. Check if the port is occupied: lsof -i :2011 2. Modify listening_ports in the YAML fil...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ons**: 1. Confirm correct config path: rocksdb.option_path=./conf/graphs/rocksdb_plus.yaml 2. Check data directory permissions: ensure...
(QB_NEW_EN)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (3)
3-5: Front matter 标题语言不一致（应与 linkTitle 同为中文）建议将 title 改为中文，保持与 linkTitle 一致，避免站点导航与 SEO 混乱。
-title: "ToplingDB YAML configuration file" +title: "ToplingDB 的 YAML 配置文件"
26-31: 统一 http.document_root 路径风格并补充访问安全提示；脚本名连字符统一与“IDEA 本地调试指南”保持一致，示例路径建议采用 library 目录风格，并在注释中说明生产环境需限制访问；同时将
preload_topling.sh统一为preload-topling.sh。- document_root: /dev/shm/rocksdb_resource # 静态资源目录, HugeGraph中通过`preload_topling.sh`进行静态资源提取 + document_root: path-to-your-directory/library/rocksdb_resource # 静态资源目录，`preload-topling.sh` 解压生成（按环境调整；生产请限制访问）
276-280: 章节编号风格不一致前文章节均带编号，“相关文档”建议补齐编号以保持一致性。
-## 相关文档 +## 8. 相关文档content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
18-22: Unify http.document_root path example and add a production access note; fix script nameAlign with the IDEA guide’s library path style and note production restriction; use
preload-topling.shconsistently.- document_root: /dev/shm/rocksdb_resource # Static resource directory, extracted by `preload_topling.sh` in HugeGraph + document_root: path-to-your-directory/library/rocksdb_resource # Extracted by `preload-topling.sh` (adjust to your env; restrict access in production)
281-285: Section numbering consistencyPrevious sections are numbered; consider numbering this as “8. Related Documentation” for consistency.
-## Related Documentation +## 8. Related Documentation
🧹 Nitpick comments (3)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (1)
83-87: 示例与默认值说明容易引起误解，建议加注释说明取值原因文中说明 use_vm 默认值为 true，而示例配置为 false，建议在示例处补一句“示例按内存充足场景关闭以减少 minor page fault”。
- use_vm: false + use_vm: false # 示例：在物理内存充足场景关闭以减少 minor page faultAlso applies to: 213-216
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (2)
218-220: Minor wording fix“needs reserved” 非标准；建议改为 “needs to reserve”。
-while CSPP only needs reserved virtual address space. +while CSPP only needs to reserve virtual address space.
151-152: Minor grammar fix“must be false to hugegraph” → “must be false for HugeGraph”。
- create_missing_column_families: false # this is important, must be false to hugegraph + create_missing_column_families: false # this is important, must be false for HugeGraph
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[uncategorized] ~196-~196: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"写入
Context: ...底层算法为了支持高并发写入，采用了预分配内存的策略。 当预分配的内存被写满时，新的写入操作将无法继续。 然而，RocksDB 本身缺乏一种机制，使得 memtab...
(wb4)
[uncategorized] ~271-~271: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：灵活"地"统计
Context: ...tcherTable 支持多工厂调度 - 内置 Web Server - 更灵活的统计与观测控制 - 特殊 DBOptions（如 memtable_as_log...
(wb4)
content/en/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md
[style] ~218-~218: The double modal “needs reserved” is nonstandard (only accepted in certain dialects). Consider “to be reserved”.
Context: ...th mapped pages), while CSPP only needs reserved virtual address space. When use_vm ...
(NEEDS_FIXED)
[grammar] ~258-~258: There might be a mistake here.
Context: ...ingDB and do not include authentication. - By default, `listening_ports: '127.0.0.1...
(QB_NEW_EN)
[grammar] ~265-~265: There might be a mistake here.
Context: ...esource` uses a shared memory directory. - In multi-user environments, ensure prope...
(QB_NEW_EN)
[grammar] ~272-~272: There might be a mistake here.
Context: ...gin-based configuration and object reuse - A new MemTable type (cspp) with a paired...
(QB_NEW_EN)
[grammar] ~273-~273: There might be a mistake here.
Context: ...e type (cspp) with a paired TableFactory - DispatcherTable for multi-factory schedu...
(QB_NEW_EN)
[grammar] ~274-~274: There might be a mistake here.
Context: ...atcherTable for multi-factory scheduling - Built-in Web Server - More flexible stat...
(QB_NEW_EN)
[grammar] ~275-~275: There might be a mistake here.
Context: ...multi-factory scheduling - Built-in Web Server - More flexible statistics and observabili...
(QB_NEW_EN)
[grammar] ~276-~276: There might be a mistake here.
Context: ...le statistics and observability controls - Special DBOptions (such as `memtable_as_...
(QB_NEW_EN)
🔇 Additional comments (1)
content/cn/blog/hugegraph/toplingdb/toplingdb-configuration-yaml.md (1)
178-181: 图片资源路径请确认存在与可访问请确认 /blog/images/images-server/toplingdb-yaml-ref.png 已随站点静态资源发布且路径正确，避免构建后 404。
Merged ToplingDB with RocksDB as a high-performance alternative in both Chinese and English quickstart guides. Updated section order and references, and removed redundant ToplingDB configuration details to streamline documentation.
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/quickstart/hugegraph/hugegraph-server.md(4 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/quickstart/hugegraph/hugegraph-server.md
47-47: Link fragments should be valid
(MD051, link-fragments)
content/en/docs/quickstart/hugegraph/hugegraph-server.md
49-49: Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (3)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (2)
320-351: ToplingDB integration well positioned and documented.The ToplingDB addition as section
5.1.3alongside RocksDB is clear, with a proper Beta notice and link to dedicated quick-start documentation. The placement and wording appropriately position it as a high-performance alternative.
501-546: Verify section numbering consistency across document.MySQL backend has been inserted as a new section
5.1.7, shifting subsequent backends down by one number. This reorganization is correct structurally, but ensure all other internal cross-references and table of contents entries (if any exist elsewhere in the documentation suite) have been updated accordingly.content/cn/docs/quickstart/hugegraph/hugegraph-server.md (1)
277-311: ToplingDB 集成文档清晰完整。ToplingDB 被恰当地位置为 RocksDB 的高性能替代方案，并附带了 Beta 声明和指向专项快速入门文档的链接。
|
|
||
| 1. 可以使用 `docker exec -it server bash` 进入容器完成一些操作 | ||
| 2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.1](/cn/docs/quickstart/hugegraph-server/#511-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE) | ||
| 2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.9](#519-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE) |
There was a problem hiding this comment.
修复交叉引用中的错误锚点。
第 47 行引用了 #519-... 锚点，但目标章节已重新编号为 5.1.8（不是 5.1.9），因为 MySQL 被添加为 5.1.4 章节。请更新锚点以匹配当前章节号。
-2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.9](#519-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE)
+2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.8](#518-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE)📝 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.
| 2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.9](#519-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE) | |
| 2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.8](#518-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
47-47: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In content/cn/docs/quickstart/hugegraph/hugegraph-server.md around line 47, the
cross-reference anchor points to "#519-..." (5.1.9) but the target section has
been renumbered to 5.1.8; update the link anchor to point to the correct section
(e.g., change "#519-..." to "#518-..." or the exact current anchor for 5.1.8) so
the in-page link correctly navigates to the "启动 server 的时候创建示例图" subsection.
| </details> | ||
|
|
||
| ##### 5.1.2 RocksDB | ||
| ##### 5.1.2 RocksDB / ToplingDB |
There was a problem hiding this comment.
🧩 Analysis chain
中英文版本的后端章节顺序不一致。
中文版本（5.1.2 为 RocksDB/ToplingDB，5.1.6 为 Memory）与英文版本（5.1.2 为 Memory，5.1.3 为 RocksDB/ToplingDB）的后端配置顺序差异显著。这会给用户造成混淆。请确认这种重组是否刻意为之，并考虑在两个版本间保持一致的顺序。
Also applies to: 357-357
---
🏁 Script executed:
```shell
#!/bin/bash
# Find both Chinese and English versions of the HugeGraph server documentation
find . -type f -name "hugegraph-server.md" 2>/dev/null | head -20
Length of output: 117
🏁 Script executed:
#!/bin/bash
# Check the Chinese version around lines 277 and 357
if [ -f "content/cn/docs/quickstart/hugegraph/hugegraph-server.md" ]; then
echo "=== Chinese version around line 277 ==="
sed -n '270,285p' "content/cn/docs/quickstart/hugegraph/hugegraph-server.md"
echo ""
echo "=== Chinese version around line 357 ==="
sed -n '350,365p' "content/cn/docs/quickstart/hugegraph/hugegraph-server.md"
fiLength of output: 795
🏁 Script executed:
#!/bin/bash
# Extract section headers from Chinese version to see the structure
if [ -f "content/cn/docs/quickstart/hugegraph/hugegraph-server.md" ]; then
echo "=== Chinese version section headers (5.1.x pattern) ==="
grep -n "^##### 5\.1\." "content/cn/docs/quickstart/hugegraph/hugegraph-server.md"
fiLength of output: 275
🏁 Script executed:
#!/bin/bash
# Check English version if it exists
if [ -f "content/en/docs/quickstart/hugegraph/hugegraph-server.md" ]; then
echo "=== English version section headers (5.1.x pattern) ==="
grep -n "^##### 5\.1\." "content/en/docs/quickstart/hugegraph/hugegraph-server.md"
fiLength of output: 307
后端配置章节顺序确实存在重大不一致，需统一调整。
验证已确认：中文版本与英文版本的后端配置顺序存在系统性差异。中文版本将Memory置于5.1.6，RocksDB/ToplingDB置于5.1.2；英文版本则将Memory置于5.1.2，RocksDB/ToplingDB置于5.1.3。此外MySQL、HBase等后端的位置也相差多个章节序号。这不仅是小的差异调整，而是全面的重组，必然给用户查阅时造成困惑。
需统一两个版本的后端章节顺序，建议采用统一的顺序标准（按功能分类、按常用度排序等），确保用户体验一致。
🤖 Prompt for AI Agents
In content/cn/docs/quickstart/hugegraph/hugegraph-server.md around line 277, the
backend configuration section ordering in the Chinese file is inconsistent with
the English version (e.g., Memory is at 5.1.6 in Chinese but 5.1.2 in English;
RocksDB/ToplingDB at 5.1.2 in Chinese vs 5.1.3 in English, with MySQL/HBase also
misordered). Reorder the backend subsections to match the canonical English
sequence (or the agreed unified standard), renumber the section headings
accordingly, update any internal anchors/TOC entries and cross-references that
rely on those section numbers, and verify the Chinese content titles match the
corresponding English subsection content after reordering.
| 1. use `docker exec -it graph bash` to enter the container to do some operations. | ||
| 2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` to start with a **built-in** example graph. We can use `RESTful API` to verify the result. The detailed step can refer to [5.1.7](#517-create-an-example-graph-when-startup) | ||
| 3. use `-e PASSWORD=xxx` to enable auth mode and set the password for admin. You can find more details from [Config Authentication](/docs/config/config-authentication#Use-docker-to-enble-authentication-mode) | ||
| 2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` to start with a **built-in** example graph. We can use `RESTful API` to verify the result. The detailed step can refer to [5.1.9](#519-create-an-example-graph-when-startup) |
There was a problem hiding this comment.
Fix incorrect anchor reference in cross-link.
Line 49 references #519-create-an-example-graph-when-startup, but the target section is now numbered 5.1.8 (not 5.1.9) after MySQL was added as section 5.1.7. Update the anchor to match.
-2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` to start with a **built-in** example graph. We can use `RESTful API` to verify the result. The detailed step can refer to [5.1.9](#519-create-an-example-graph-when-startup)
+2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` to start with a **built-in** example graph. We can use `RESTful API` to verify the result. The detailed step can refer to [5.1.8](#518-create-an-example-graph-when-startup)📝 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.
| 2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` to start with a **built-in** example graph. We can use `RESTful API` to verify the result. The detailed step can refer to [5.1.9](#519-create-an-example-graph-when-startup) | |
| 2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` to start with a **built-in** example graph. We can use `RESTful API` to verify the result. The detailed step can refer to [5.1.8](#518-create-an-example-graph-when-startup) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
49-49: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In content/en/docs/quickstart/hugegraph/hugegraph-server.md around line 49, the
cross-link anchor currently points to #519-create-an-example-graph-when-startup
which is incorrect after re-numbering; update the anchor to
#518-create-an-example-graph-when-startup (i.e., change the link target in the
text from 5.1.9 to 5.1.8 or directly update the fragment to match the current
section id) so the link correctly navigates to the "Create an example graph when
startup" section.
4 participants
Purpose of the PR
Summary by CodeRabbit
新功能
文档