Skip to content

docs: refactor docs of loader & client for new version(1.7.0)#415

Merged
imbajin merged 11 commits intoapache:masterfrom
sadwitdastreetz:toolchain-update
Dec 1, 2025
Merged

docs: refactor docs of loader & client for new version(1.7.0)#415
imbajin merged 11 commits intoapache:masterfrom
sadwitdastreetz:toolchain-update

Conversation

@sadwitdastreetz
Copy link
Contributor

@sadwitdastreetz sadwitdastreetz commented Sep 9, 2025

  1. Updated Maven version to 1.7.0 - Updated client dependency version from 1.5.0 to 1.7.0 in both Chinese and English
    documentation
  2. Added GraphSpace documentation - Added comprehensive documentation for GraphSpace functionality in both Chinese
    (content/cn/docs/clients/hugegraph-client.md) and English (content/en/docs/clients/hugegraph-client.md) versions:
    - GraphSpace creation and management
    - Graph management within GraphSpaces
    - Complete API interface summary
  3. Updated client examples - Modified client connection examples to include GraphSpace parameter ("DEFAULT") in both
    quickstart guides
  4. Fixed loader documentation parameters - Updated HugeGraph-Loader documentation to include:
    - Added --graphspace parameter (-gs)
    - Added alternative host parameter (-i)
    - Fixed parameter descriptions
image image

added graphspace part for docs of client
changed client examples to NEWER version
fixed parameters in loader docs
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Sep 9, 2025
@sadwitdastreetz sadwitdastreetz changed the title docs: refactor docs of loader & client for new version docs: refactor docs of loader & client for new version(1.7.0) Sep 9, 2025
@dosubot dosubot bot added the enhancement New feature or request label Sep 9, 2025
@sadwitdastreetz
Copy link
Contributor Author

@coderabbitai review

@Thespica Thespica requested a review from Copilot September 9, 2025 13:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the HugeGraph documentation to reflect version 1.7.0 changes, adds GraphSpace support documentation, and corrects parameter descriptions in the loader documentation.

  • Updated Maven version references from 1.5.0 to 1.7.0
  • Added comprehensive GraphSpace functionality documentation for client APIs
  • Fixed parameter descriptions in loader documentation (graph vs graphspace parameters)

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
content/en/docs/quickstart/toolchain/hugegraph-loader.md Fixed parameter descriptions and added graphspace parameter
content/en/docs/quickstart/client/hugegraph-client.md Updated version to 1.7.0 and modernized client examples
content/en/docs/clients/hugegraph-client.md Added GraphSpace management documentation
content/cn/docs/quickstart/toolchain/hugegraph-loader.md Fixed parameter descriptions in Chinese version
content/cn/docs/quickstart/client/hugegraph-client.md Updated version to 1.7.0 in Chinese examples
content/cn/docs/clients/hugegraph-client.md Added GraphSpace documentation in Chinese
Comments suppressed due to low confidence (5)

content/en/docs/quickstart/toolchain/hugegraph-loader.md:1

  • Missing 'N' in the Required column for the -gs or --graphspace parameter. Should be 'N' instead of empty.
---

content/en/docs/quickstart/toolchain/hugegraph-loader.md:1

  • Missing backticks around -i parameter. Should be || \-h` or `--host` or `-i` |` for consistency with other parameter formatting.
---

content/cn/docs/quickstart/toolchain/hugegraph-loader.md:1

  • Incomplete word in description. '图数据库h' should be '图数据库' (missing character or typo).
---

content/cn/docs/quickstart/toolchain/hugegraph-loader.md:1

  • Missing 'N' in the Required column for the -gs or --graphspace parameter. Should be 'N' instead of empty.
---

content/cn/docs/quickstart/toolchain/hugegraph-loader.md:1

  • Missing backticks around -i parameter. Should be || \-h` 或 `--host` 或 `-i` |` for consistency with other parameter formatting.
---

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

.configUser("username", "password")
// 这是示例,生产环境需要使用安全的凭证
.build();

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ 代码风格问题:缩进不一致

这里的缩进与上下文不一致,建议使用相同的缩进风格:

```suggestion
.configUser("username", "password")
// 这是示例,生产环境需要使用安全的凭证
.build();
```

应保持一致的缩进,使用空格对齐。

@@ -817,7 +842,7 @@ schema: 必填
| `--check-vertex` | false | | 插入边时是否检查边所连接的顶点是否存在 |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 格式问题:表格末尾多余空格

这行末尾有多余的空格列分隔符,建议移除:

```suggestion
| `--help` | false | | 打印帮助信息 |
```

##### 3.3.2 Input Source

Input sources are currently divided into four categories: FILE, HDFS, JDBC and KAFKA, which are distinguished by the `type` node. We call them local file input sources, HDFS input sources, JDBC input sources, and KAFKA input sources, which are described below.
Input sources are currently divided into four categories: FILE, HDFS, JDBC, KAFKA and GRAPH, which are distinguished by the `type` node. We call them local file input sources, HDFS input sources, JDBC input sources, KAFKA input sources and GRAPH input source, which are described below.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ 中英文描述不一致

英文版说"four categories"但列举了五种类型,与中文版不一致。建议修改为 "five categories":

```suggestion
Input sources are currently divided into five categories: FILE, HDFS, JDBC, KAFKA and GRAPH, which are distinguished by the `type` node. We call them local file input sources, HDFS input sources, JDBC input sources, KAFKA input sources and GRAPH input source, which are described below.
```

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 1, 2025
@imbajin imbajin merged commit 1e297a2 into apache:master Dec 1, 2025
1 check passed
github-actions bot pushed a commit that referenced this pull request Dec 1, 2025
* fixed mvn version to 1.7.0
added graphspace part for docs of client
changed client examples to NEWER version
fixed parameters in loader docs 1e297a2
ChoHee15 pushed a commit to hugegraph/hugegraph-doc that referenced this pull request Dec 3, 2025
…#415)

* fixed mvn version to 1.7.0
added graphspace part for docs of client
changed client examples to NEWER version
fixed parameters in loader docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants