Add telemetry docs #381
Add telemetry docs #381
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the new telemetry feature as described in Node-RED issue #5102.
- Added a new "Usage Telemetry" section in the User Guide with a link to the telemetry docs.
- Created a new telemetry documentation page outlining what data is collected, why, and how users can opt out.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/user-guide/index.md | Added a new section and link for usage telemetry. |
| docs/telemetry/index.md | Introduced a new page with comprehensive telemetry docs. |
| You can change you made via the Editor Settings dialog at any time. | ||
|
|
There was a problem hiding this comment.
The phrase 'You can change you made' appears to be a grammatical error. Consider revising it to something like 'You can change your preference via the Editor Settings dialog at any time.'
| You can change you made via the Editor Settings dialog at any time. | |
| You can change your preference via the Editor Settings dialog at any time. |
Copilot uses AI. Check for mistakes.
|
|
||
| With the usage telemetry feature enabled, in response to sending the information, Node-RED | ||
| is notified when there is a new version available. This will generate a notification | ||
| in the editor tp help you know when its time to upgrade. |
There was a problem hiding this comment.
The word 'tp' seems to be a typo. It should likely be 'to', making the sentence read: 'in the editor to help you know when it's time to upgrade.'
| in the editor tp help you know when its time to upgrade. | |
| in the editor to help you know when it's time to upgrade. |
Copilot uses AI. Check for mistakes.
|
Apart from the 2 typos copilot points out it reads well. My personal take is we dont front load the information about benefits. e.g. how enabling telemetry permits update notifications, how it will help us make decisions on the direction of Node-RED project etc. I feel that could go very early in the document under the Why section. An additional thought that occurred to me was since we are making this front and center and opt-in to enable, we could include a little more info - in particular installed modules and versions. That would provide another dimension making the data much richer. I appreciate though that you have likely considered this and have reasons for not including it here. |
Part of node-red/node-red#5102
Add docs for the new telemetry feature.