docs: update network #33488
docs: update network #33488
Conversation
Summary of ChangesHello @guanshengliang, 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! 此拉取请求旨在优化 TDengine 的网络配置相关文档。通过重命名和整合现有文档，将 IPv6 和 TLS 的配置指南统一到一份新的“网络配置”文档中，并更新了所有相关引用。这提高了文档的组织性和可读性，确保用户能更便捷地找到关于 TDengine 网络环境配置的全面信息。 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
|
![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 updates the network-related documentation by consolidating IPv6 and TLS information into a new network.md file and updating links accordingly. The changes are a good improvement, enhancing clarity and structure. I've provided a few suggestions to further improve the documentation, including fixing a missing configuration parameter in an example, improving link formatting for consistency, and adjusting document structure for better readability.
| ``` | ||
| // 设置 TDengine 服务端在指定网络接口上监听 IPv6 地址，值为该接口对应的 IPv6 地址，或 "::" 表示监听所有可用 IPv6 接口 | ||
| firstEp ipv6_address1:port | ||
| secondEp ipv6_address2:port | ||
| fqdn ipv6_address1 | ||
| enableIPv6 1 | ||
| ``` |
There was a problem hiding this comment.
The IPv6 configuration example is missing the serverIPv6 parameter. According to the English documentation and the previous version of this document, this parameter is used to set the IPv6 address for the server to listen on (e.g., serverIPv6 :: to listen on all available IPv6 interfaces). Omitting this could lead to incomplete configurations for users. Please add this parameter and an example.
| ``` | |
| // 设置 TDengine 服务端在指定网络接口上监听 IPv6 地址，值为该接口对应的 IPv6 地址，或 "::" 表示监听所有可用 IPv6 接口 | |
| firstEp ipv6_address1:port | |
| secondEp ipv6_address2:port | |
| fqdn ipv6_address1 | |
| enableIPv6 1 | |
| ``` | |
| // 设置 TDengine 服务端在指定网络接口上监听 IPv6 地址，值为该接口对应的 IPv6 地址，或 "::" 表示监听所有可用 IPv6 接口 | |
| // 例如: | |
| serverIPv6 :: | |
| firstEp ipv6_address1:port | |
| secondEp ipv6_address2:port | |
| fqdn ipv6_address1 | |
| enableIPv6 1 |
|
|
||
|
|
||
|
|
||
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 其中 IPv6 内容参见 (../08-operation/13-network.md) |
There was a problem hiding this comment.
For better readability and correctness, it's recommended to format this link using standard Markdown syntax. Also, the text should be updated to reflect the full content of the linked document (network configuration, not just IPv6).
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 其中 IPv6 内容参见 (../08-operation/13-network.md) | |
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 相关网络配置请参见[网络配置](../08-operation/13-network.md)。 |
| - `set_core.sh`: 用于方便调试设置系统生成 core dump 文件的脚本 | ||
| - `taosd-dump-cfg.gdb`: 用于方便调试 taosd 的 gdb 执行脚本。 | ||
|
|
||
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 其中 IPv6 内容参见 (../08-operation/13-network.md) |
There was a problem hiding this comment.
To improve the document's structure, it would be clearer to place this information under a new subheading. Additionally, the link should use standard Markdown format and a more accurate link text.
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 其中 IPv6 内容参见 (../08-operation/13-network.md) | |
| ## 网络环境支持 | |
| TDengine 支持 IPv4 和 IPv6 两种通信方式，相关网络配置请参见[网络配置](../08-operation/13-network.md)。 |
|
|
||
|
|
||
|
|
||
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 其中 IPv6 内容参见 [IPv6 配置](../08-operation/13-network.md) |
There was a problem hiding this comment.
To more accurately reflect the content of the linked document (which covers both IPv6 and TLS configuration), it's better to change the link text from "IPv6 配置" (IPv6 Configuration) to "网络配置" (Network Configuration) and adjust the sentence for better flow.
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 其中 IPv6 内容参见 [IPv6 配置](../08-operation/13-network.md) | |
| TDengine 支持 IPv4 和 IPv6 两种通信方式, 相关网络配置请参见[网络配置](../08-operation/13-network.md)。 |
Description
Please briefly describe the code changes in this pull request.
Checklist
Please check the items in the checklist if applicable.