search

MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.2k stars 21.35k forks source link

Endpoint reference #65354

Closed taylor-anderson821 closed 3 years ago

taylor-anderson821 commented 3 years ago

As someone who is new to ADT, endpoints, routes, topics, and subscriptions, I found this line in this page confusing:

"Next, create an Azure Digital Twins endpoint pointing to your event grid topic. Use the command below, filling in the placeholder fields as necessary:"

The CLI reference for: az dt endpoint create eventgrid found here https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/dt/endpoint/create?view=azure-cli-latest

Says that CLI command 'az dt endpoint create eventgrid' "adds an EventGrid Topic endpoint to a Digital Twins instance. Requires pre-created resource"

So I think it would be more clear for the ADT doc to say that it is adding an Event Grid topic endpoint to the instance rather than an adding an ADT endpoint.

T

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ChaitanyaNaykodi-MSFT commented 3 years ago

Hello @jjadta, Thank you for your feedback! We will review and update as appropriate.

baanders commented 3 years ago

Thanks @jjadta for the comment! This makes sense.

The intent was to clarify that while Event Grid, Service Bus, etc... are other Azure services that you set up separately, the endpoint is part of the ADT instance. However, I see how this could be confusing, especially when the wording is different from the CLI documentation.

Here's a suggested rewrite for the sentence: "Next, create an Event Grid endpoint in Azure Digital Twins, which will connect your instance to your event grid topic."

Do you think this adds the needed clarification?

taylor-anderson821 commented 3 years ago

Yes, reads well!

On Tue, Nov 3, 2020 at 9:58 AM Bailey Anderson notifications@github.com wrote:

Thanks @jjadta https://github.com/jjadta for the comment! This makes sense.

The intent was to clarify that while Event Grid, Service Bus, etc... are other Azure services that you set up separately, the endpoint is part of the ADT instance. However, I see how this could be confusing, especially when the wording is different from the CLI documentation.

Here's a suggested rewrite for the sentence: "Next, create an Event Grid endpoint in Azure Digital Twins, which will connect your instance to your event grid topic."

Do you think this adds the needed clarification?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/MicrosoftDocs/azure-docs/issues/65354#issuecomment-721286825, or unsubscribe https://github.com/notifications/unsubscribe-auth/AGTTG74OAB2PYJ6DUBVGMSTSOBADBANCNFSM4TGWKR7Q .

-- Sent from Gmail Mobile

baanders commented 3 years ago

@jjadta Great, thanks for the confirmation!

I am making this edit in PR #136417, and will have Git close this issue when the fix is merged. (You can still feel free to comment back on this thread with additional comments or questions if needed.)

Thanks again for the feedback!