Skip to content

Enhance SSE connector documentation with event details #128425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sandervandevelde wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

Enhance SSE connector documentation with event details #128425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions articles/iot-operations/discover-manage-assets/howto-use-sse-connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Your IT administrator must configure the connector for SSE template for your Azu

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.
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

“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.

Suggested change
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.

Copilot uses AI. Check for mistakes.

## Deploy the connector for SSE

[!INCLUDE [deploy-connectors-simple](../includes/deploy-connectors-simple.md)]
Expand Down Expand Up @@ -199,9 +201,9 @@ An event group defines where the connector sends the data it receives from a col

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" />
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
<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":::

Copilot uses AI. Check for mistakes.

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.
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.

1. On the **Review** page, review the details of the asset and select **Create** to create the asset. After a few minutes, the asset is listed on the **Assets** page:

Expand Down