ApplicationInsights-dotnet icon indicating copy to clipboard operation
ApplicationInsights-dotnet copied to clipboard

API Doc doesn't list all Derived Telemetry Channels

Open jsquire opened this issue 1 year ago • 5 comments

Issue Transfer

This issue has been transferred from the Azure SDK for .NET repository, #18651.

Please be aware that @tsahi is the author of the original issue and include them for any questions or replies.

Details

ServerTelemetryChannel also implements this interface.


Document Details

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

jsquire avatar Jun 29 '23 15:06 jsquire

HI @jsquire, why was this transferred here?

Yes, this is our product, but our team doesn't own this page. This page in particular has a link, "Submit and view feedback for this page" which links to the "azure-sdk-for-net" repo.

My understanding is that these API pages are autogenerated from the published DLL. Whatever process is publishing this doc isn't taking our other libraries into consideration.

TimothyMothra avatar Jun 29 '23 16:06 TimothyMothra

@tsahi, sorry for the confusion. I see that this is a very old issue (2018). For future reference, we have a guide on our TelemetryChannels here: https://learn.microsoft.com/azure/azure-monitor/app/telemetry-channels

TimothyMothra avatar Jun 29 '23 16:06 TimothyMothra

@TimothyMothra: The documentation on this page is derived directly from the doc comments in the source code. To update it requires a change to the product code maintained in this repository. I'm not sure why it wasn't identified as not being part of the source in the Azure SDK repository earlier, but there's no action that can be taken from there.

jsquire avatar Jun 29 '23 17:06 jsquire

@jsquire do you know who owns that page? This repo publishes 16 packages, but I only see one documented.

TimothyMothra avatar Jun 29 '23 17:06 TimothyMothra

@TimothyMothra: I do not. You may want to transfer to the main Azure Docs repo and ask the docs team to investigate. The Azure SDK team only owns the docs integration for packages released from our repositories. I don't know much about the process outside of that.

jsquire avatar Jun 29 '23 17:06 jsquire