Skip to content

Update diagnostic URLs #9179

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

Merged
merged 2 commits into from
May 9, 2025
Merged

Update diagnostic URLs #9179

merged 2 commits into from
May 9, 2025

Conversation

adegeo
Copy link
Contributor

@adegeo adegeo commented May 8, 2025

Description

Technically depends on dotnet/docs-aspire#3379 but it's not required to merge. Docs will ship soon. Done

Intellisense didn't show HelpLink on the MSBuild actions, but the MSBuild docs said it's supported.

Fixes #8936

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • No
  • Did you add public API?
    • No
  • Does the change make any security assumptions or guarantees?
    • No
  • Does the change require an update in our Aspire docs?
    • Yes, already in progress

@github-actions github-actions bot added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label May 8, 2025
Copy link
Member

@danmoseley danmoseley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming we get the aka links up before we ship, lgtm.

@@ -54,7 +54,7 @@ public static class ContainerAppExtensions
/// </code>
/// </example>
/// </remarks>
[Experimental("ASPIREACADOMAINS001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
[Experimental("ASPIREACADOMAINS001", UrlFormat = "https://aka.ms/aspire/diagnostic/{0}")]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it matters, some of these are not in https://github.com/dotnet/aspire/blob/main/docs/list-of-diagnostics.md

(not sure why we have htat file exactly though)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be a reference file devs should use to look up existing IDs? But honestly you should have a review process about creating those with some approval mechanism and really you should switch to using a constant. It's very easy to accidentally name one wrong when you're trying to apply it. 😁

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason we're changing the convention (which is https://aka.ms/dotnet/<repo>/diagnostics#{0})?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we're doing work (such as the CLI) to make Aspire accessible to non-.NET developers, so it makes sense.

@adegeo adegeo added the NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons) label May 9, 2025
@adegeo
Copy link
Contributor Author

adegeo commented May 9, 2025

I created the aka links using diagnostics not diagnostic... Let me fix. We can alter the code or adjust each link. Find replace in code is quicker than using the web UI to adjust each link.

@adegeo adegeo removed the NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons) label May 9, 2025
@adegeo adegeo closed this May 9, 2025
@adegeo adegeo reopened this May 9, 2025
@danmoseley danmoseley merged commit 1490654 into main May 9, 2025
332 of 335 checks passed
@danmoseley danmoseley deleted the adegeo/diagnostics branch May 9, 2025 17:24
@github-actions github-actions bot locked and limited conversation to collaborators Jun 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adjust URLs used for diagnostic/analyzer help
3 participants