Update SmtpClient.xml #10010
Update SmtpClient.xml #10010
Conversation
Remove reference to MailKit as we should not be recommending third party tools (that is up to the user to determine). We have also been receiving support cases for MailKit (because it is referred to in our docs).
|
We make similar recommendations in other places, e.g. https://github.com/dotnet/dotnet-api-docs/blob/main/includes%2Fdrawing.md#L12 |
|
MailKit should not be referenced in our docs as it is not a Microsoft product and is available open-source from Github.
We have received support cases on it - hence removing the references from our docs. Referring to it in our docs implies that Microsoft recommends this library. We don't - it is up to customer to choose.
From: Miha Zupan ***@***.***>
Sent: Tuesday, June 11, 2024 10:45 AM
To: dotnet/dotnet-api-docs ***@***.***>
Cc: David Barrett ***@***.***>; Author ***@***.***>
Subject: Re: [dotnet/dotnet-api-docs] Update SmtpClient.xml (PR #10010)
We make similar recommendations in other places, e.g. https://github.com/dotnet/dotnet-api-docs/blob/main/includes%2Fdrawing.md#L12
How come MailKit is more problematic?
-
Reply to this email directly, view it on GitHub<#10010 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AJMV7JNPB7WNJW52GYXQSDTZG3BIDAVCNFSM6AAAAABJD6ECI6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNRQGI4DQNBZG4>.
You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>
|
|
The other examples I linked likewise include non Microsoft open source products. If it's really needed, should we instead add clarifications that these are external projects? Removing helpful references from documentation seems counter productive. |
|
It isn't a helpful reference if it generates support cases for us, as it is not something we support. It seems to generate more problems than it solves, so I don't agree that it is a helpful reference. I've tested the library - it is not intuitive, and doesn't seem to work particularly well. If customers want to use it, that is their call - but we shouldn't be recommending it. |
|
Learn Build status updates of commit 374624e: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Summary
Remove reference to MailKit as we should not be recommending third party tools (it is up to the user to determine whether a third party tool is appropriate). We have also been receiving support cases for MailKit (because it is referred to in our docs).