Enhance SSE connector documentation with event details#128425
Enhance SSE connector documentation with event details#128425sandervandevelde wants to merge 1 commit intoMicrosoftDocs:mainfrom
Conversation
Original picture was showing OPC-UA tag as data source. This is replace with an SSE event picture. Added instructions for SSE event identification and clarified event details for MQTT publishing.
|
@sandervandevelde : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 038851f: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the SSE connector how-to to better explain how to identify SSE events and how event details map to MQTT publishing, including updating the “Add event” screenshot.
Changes:
- Added a prerequisite note to have SSE event identification ready before deployment.
- Replaced the “Add event” screenshot and updated accompanying instructions to mention SSE event identification and MQTT topic.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| You need any credentials required to access the SSE source. If the SSE source requires authentication, you need to create a Kubernetes secret that contains the username and password for the SSE source. | ||
|
|
||
| Have the event identification ready for each SSE source event you want to receive. |
There was a problem hiding this comment.
“Event identification” is introduced without defining what exact value the user should gather (for SSE this is commonly the event: name/type and/or the id: field). Consider briefly defining it here (or linking to a section) and remove the trailing whitespace at end of line to avoid lint/build noise in docs pipelines.
| Have the event identification ready for each SSE source event you want to receive. | |
| Have the event identification ready for each SSE source event you want to receive, such as the SSE `event:` name or type and, if available, the `id:` field. |
| 1. Select **Add event** to add an event to the group. For example: | ||
|
|
||
| :::image type="content" source="media/howto-use-sse-connector/add-event.png" alt-text="Screenshot that shows how to add an event for SSE source." lightbox="media/howto-use-sse-connector/add-event.png"::: | ||
| <img width="1247" height="671" alt="Screenshot that shows how to add an event for SSE source." src="https://github.com/user-attachments/assets/d82dd9f5-5d0e-48ba-994e-dfa6ad1a4cd5" /> |
There was a problem hiding this comment.
The doc switches from the standard :::image directive to a raw HTML <img> pointing to an external github.com/user-attachments URL with fixed dimensions. This is brittle (link longevity), can break offline builds, and fixed width/height can hurt responsiveness. Prefer checking the image into the repo under the local media/ folder and using the :::image directive with source/lightbox.
| <img width="1247" height="671" alt="Screenshot that shows how to add an event for SSE source." src="https://github.com/user-attachments/assets/d82dd9f5-5d0e-48ba-994e-dfa6ad1a4cd5" /> | |
| :::image type="content" source="media/howto-use-sse-connector/sse-add-event.png" alt-text="Screenshot that shows how to add an event for SSE source." lightbox="media/howto-use-sse-connector/sse-add-event.png"::: |
| <img width="1247" height="671" alt="Screenshot that shows how to add an event for SSE source." src="https://github.com/user-attachments/assets/d82dd9f5-5d0e-48ba-994e-dfa6ad1a4cd5" /> | ||
|
|
||
| Add details for each event to publish to the MQTT broker. Select **Next** to continue. | ||
| Add details for each event like the SSE event identification as data source and MQTT topic as destination to publish to the MQTT broker. Select **Next** to continue. |
There was a problem hiding this comment.
This sentence is a bit hard to parse and may leave readers unsure which UI fields to populate (e.g., whether “event identification” refers to an event name/type vs an ID). Consider splitting into two short sentences and explicitly naming the UI fields (Data source = SSE event name/type/ID; Destination = MQTT topic) to reduce ambiguity.
| Add details for each event like the SSE event identification as data source and MQTT topic as destination to publish to the MQTT broker. Select **Next** to continue. | |
| Enter the details for each event. Set **Data source** to the SSE event identifier and **Destination** to the MQTT topic to publish to the MQTT broker. Select **Next** to continue. |
|
@sandervandevelde - many thanks for these updates - I'll make the changes in including adding an updated screenshot in our repo next week and report back here when I've made the changes. |
Original picture was showing OPC-UA tag as data source. This is replace with an SSE event picture.
Added instructions for SSE event identification and clarified event details for MQTT publishing.