Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds new documentation pages under connect-emqx describing how to use Node-RED with EMQX, including installation, broker setup, example flows, testing steps, and troubleshooting guidance, and wires the new page into the docs navigation.
Changes:
- Add Node-RED + EMQX guide in English and Chinese.
- Add supporting screenshots under each locale’s
connect-emqx/assets/. - Register the new page in
dir.yamlso it appears in the Developer Guide navigation.
Reviewed changes
Copilot reviewed 3 out of 23 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
en_US/connect-emqx/node-red.md |
New EN Node-RED guide page (install, connect, flows, troubleshooting). |
zh_CN/connect-emqx/node-red.md |
New CN Node-RED guide page mirroring the EN content. |
en_US/connect-emqx/assets/access_node_red_editor.png |
Screenshot asset referenced by the EN page. |
en_US/connect-emqx/assets/config_publish_node.png |
Screenshot asset referenced by the EN page. |
en_US/connect-emqx/assets/subscribe_to_topic.png |
Screenshot asset referenced by the EN page. |
zh_CN/connect-emqx/assets/access_node_red_editor.png |
Screenshot asset referenced by the CN page. |
zh_CN/connect-emqx/assets/config_publish_node.png |
Screenshot asset referenced by the CN page. |
dir.yaml |
Adds connect-emqx/node-red to the Developer Guide section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+47
to
+54
| | Parameter | Value | | ||
| | --------------- | ---------------- | | ||
| | Broker Address | `broker.emqx.io` | | ||
| | TCP Port | `1883` | | ||
| | SSL/TLS Port | `8883` | | ||
| | WebSocket Port | `8083` | | ||
| | Secure WebSocket Port | `8084` | | ||
|
|
There was a problem hiding this comment.
The broker parameter table uses double leading pipes (|| ...) on each row, which is not standard Markdown table syntax and may render incorrectly. Use a single | at the start of each row (as in other docs, e.g., en_US/connect-emqx/curl.md).
Comment on lines
+47
to
+53
| | 参数 | 值 | | ||
| | ---------------- | ---------------- | | ||
| | Broker 地址 | `broker.emqx.io` | | ||
| | TCP 端口 | `1883` | | ||
| | SSL/TLS 端口 | `8883` | | ||
| | WebSocket 端口 | `8083` | | ||
| | 加密 WebSocket 端口 | `8084` | |
There was a problem hiding this comment.
The broker parameter table uses double leading pipes (|| ...) on each row, which is not standard Markdown table syntax and may render incorrectly. Use a single | at the start of each row (consistent with other pages).
Suggested change
| | 参数 | 值 | | |
| | ---------------- | ---------------- | | |
| | Broker 地址 | `broker.emqx.io` | | |
| | TCP 端口 | `1883` | | |
| | SSL/TLS 端口 | `8883` | | |
| | WebSocket 端口 | `8083` | | |
| | 加密 WebSocket 端口 | `8084` | | |
| | 参数 | 值 | | |
| | -------------------- | ---------------- | | |
| | Broker 地址 | `broker.emqx.io` | | |
| | TCP 端口 | `1883` | | |
| | SSL/TLS 端口 | `8883` | | |
| | WebSocket 端口 | `8083` | | |
| | 加密 WebSocket 端口 | `8084` | |
|
|
||
| ## Prerequisites | ||
|
|
||
| - Node.js 14 or later (for NPM installation) |
There was a problem hiding this comment.
The prerequisite lists Node.js 14+, but Node.js 14 is end-of-life. Consider updating this to a currently supported Node.js LTS version range (and aligning with the Node-RED version you expect readers to use) to avoid installation failures or security issues.
Suggested change
| - Node.js 14 or later (for NPM installation) | |
| - Node.js 18 LTS or 20 LTS (for NPM installation) |
|
|
||
| ## 前提条件 | ||
|
|
||
| - Node.js 14 或更高版本（使用 NPM 安装时需要） |
There was a problem hiding this comment.
前提条件中写的是 Node.js 14+，但 Node.js 14 已停止维护。建议更新为当前受支持的 Node.js LTS 版本范围（并与预期使用的 Node-RED 版本对齐），避免读者安装失败或使用过期版本。
Suggested change
| - Node.js 14 或更高版本（使用 NPM 安装时需要） | |
| - 受支持的 Node.js LTS 版本，例如 Node.js 18 或更高版本（使用 NPM 安装时需要） |
🔗 Link Check ResultsSummary
Errors per inputErrors in en_US/connect-emqx/curl.md
Errors in en_US/connect-emqx/node-red.md
Errors in en_US/data-integration/introduction.md
Errors in en_US/deploy/cluster/create-cluster.md
Errors in en_US/emqx-ai/rtc-services/volcengine-rtc/quick-start.md
Errors in en_US/getting-started/feature-comparison.md
Errors in ja_JP/connect-emqx/curl.md
Errors in ja_JP/connect-emqx/node-red.md
Errors in ja_JP/deploy/cluster/create-cluster.md
Errors in ja_JP/emqx-ai/rtc-services/volcengine-rtc/quick-start.md
Errors in ja_JP/getting-started/feature-comparison.md
Errors in ja_JP/index.md
Errors in ja_JP/performance/benchmark-emqtt-bench.md
Errors in zh_CN/data-integration/introduction.md
Errors in zh_CN/deploy/cluster/create-cluster.md
Errors in zh_CN/emqx-ai/rtc-services/volcengine-rtc/quick-start.md
Errors in zh_CN/faq/concept.md
Errors in zh_CN/getting-started/feature-comparison.md
Errors in zh_CN/support/technical-support.md
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.