Skip to content
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.

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

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

Closed
christothes opened this issue Jun 26, 2021 · 3 comments
Closed
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. EngSys This issue is impacting the engineering system.

Comments

@christothes
Copy link
Member

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

#22215

@christothes christothes added the EngSys This issue is impacting the engineering system. label Jun 26, 2021
@scottaddie
Copy link
Member

scottaddie commented Oct 20, 2021

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:

/// <see href="https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" />

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

Copy link

github-actions bot commented Mar 4, 2024

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.

1 similar comment
Copy link

github-actions bot commented Apr 5, 2024

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 github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Apr 5, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to 🎊 Closed in Azure SDK EngSys 🚢🎉 Apr 5, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Apr 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Central-EngSys This issue is owned by the Engineering System team. EngSys This issue is impacting the engineering system.
Projects
Archived in project
Development

No branches or pull requests

5 participants