azure-sdk-for-net icon indicating copy to clipboard operation
azure-sdk-for-net copied to clipboard

CI needs an analysis step to validate http links in XML doc comments

Open christothes opened this issue 3 years ago • 1 comments

PRs like this are a good example of the need for some link validation to check for things like locales.

https://github.com/Azure/azure-sdk-for-net/pull/22215

christothes avatar Jun 26 '21 00:06 christothes

In addition to flagging locale strings, the analysis step should flag MSDN links. All msdn.microsoft.com links should be replaced with docs.microsoft.com links. Here's an example of a link that violates both rules: https://github.com/Azure/azure-sdk-for-net/blob/c7e337df47b80c123b023352be6e39d81136ba81/sdk/eventhub/Microsoft.Azure.Management.EventHub/src/Generated/PrivateEndpointConnectionsOperationsExtensions.cs#L26

@weshaggard This is related to our chat. The link checker script currently scans Markdown files. This proposal entails expanding beyond that to include *.cs files.

scottaddie avatar Oct 20 '21 18:10 scottaddie

Hi @christothes, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

github-actions[bot] avatar Mar 04 '24 19:03 github-actions[bot]

Hi @christothes, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

github-actions[bot] avatar Apr 05 '24 18:04 github-actions[bot]