-
Notifications
You must be signed in to change notification settings - Fork 6k
Document MSBuild integration #38846
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
Document MSBuild integration #38846
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You will need to also update the toc file to have the correct grouping for this new file.
@IEvangelist would it be possible to introduce folders so we can avoid the need for toc update? I also have some complex toc for the analyzers in another PR.
Folders don't have any impact on the TOC. While you can structure your files however you deem necessary, they're not related to the TOC. The TOC is managed via the toc.yml. |
@Evangelink @IEvangelist folders do impact SEO and I believe we're already at the limit before we get dinged. |
That's interesting. I have added a lot of docs for CAxxxx rules and I have never touched the toc.yml and yet the grouping is working as expected.
Is there a way to have something similar to https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1822 for us in testing without having the folders? https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1822? I mean I would like to have something like https://learn.microsoft.com/dotnet/core/testing/mstest/analyzers/MSTEST0001 and https://learn.microsoft.com/dotnet/core/testing/mstest/runner/intro instead of https://learn.microsoft.com/dotnet/core/testing/unit-testing-mstest-runner-intro |
Someone probably did it for you and you just didn't notice ;) we do that a lot with the TOC.
things like CA1822 are error/warning codes and are really reference articles with a very specific search term (CA1822). That term is probably not used in other articles very much and we don't have to worry about other articles interfering with its SEO capabilities. And we sort of expect users to F1 in visual studio and get a direct link to them. Conceptual articles like this one that teach someone how to enable something, we expect them to find by searching for things like "How do I enable MSTest?" so SEO is important here. Google deprioritizes articles with lots of folder segments because they look like spam sites: |
I am actually asking for #38845 where I am adding analyzers for MSTest. I do expect the same logic where users will F1 on VS and will look up for the analyzer code. This is also similar to the SYSLIBxxxx issues https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib0014 |
Yeah, that's fine and makes sense for more analyzer content. |
…ocs-1 into dotnet-test-integration
Co-authored-by: Andy (Steve) De George <67293991+adegeo@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: Amaury Levé <amaury.leve@gmail.com>
@adegeo I addressed all the feedbacks now. Can you please accept and merge? :) |
Ping @adegeo @IEvangelist |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few more nits, otherwise let's
Co-authored-by: David Pine <david.pine@microsoft.com>
Awesome, thanks! I have applied the changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Summary
Document MSTest runner and dotnet test integration and the various options tied to the MSBuild task.
Fixes #Issue_Number (if available)
Internal previews
dotnet test