Skip to content

Refresh testing docs #45032

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 11 commits into from
Mar 1, 2025
Merged

Refresh testing docs #45032

merged 11 commits into from
Mar 1, 2025

Conversation

Youssef1313
Copy link
Member

@Youssef1313 Youssef1313 commented Feb 26, 2025

Summary of the changes:

  • Restructures the ToC
    • MTP and the test frameworks are now not at the same level. Having them at the same level is misleading. The test frameworks are now grouped under "Test frameworks" node, and MTP is added under "Test platforms" node.
  • nit: Rename xUnit header to xUnit.net in testing/index.md
  • Enrich the documentation for Testing tools section in testing/index.md
    • Instead of talking right away about test frameworks in that section. It's now divided into two parts. The test platforms and test frameworks. The test platforms gives a quick history overview and mentions MTP. It wasn't ideal that testing/index.md didn't mention MTP at all. As that page is expected to be the first page for users looking into information related to testing.
    • For each major frameworks, there is now a link to enabling MTP support.
  • Improve MSTest runner page
    • Clarify that page by making "Microsoft.Testing.Platform" more mainstream in wording and title.
    • Avoid mentioning a preview version.
    • Add TestingPlatformDotnetTestSupport as part of the steps to enable MTP. I have seen projects in reality that enabled MTP only by EnableMSTestRunner, which seems to be like they followed the documentation. So they are not completely migrating to MTP due to that.
  • Update NUnit runner page with similar changes as MSTest runner page
  • Add xUnit official doc for MTP in ToC

Internal previews

📄 File 🔗 Preview link
docs/ai/conceptual/evaluation-libraries.md The Microsoft.Extensions.AI.Evaluation libraries (Preview)
docs/core/testing/index.md Testing in .NET
docs/core/testing/unit-testing-mstest-runner-intro.md Microsoft.Testing.Platform support in MSTest (MSTest runner)
docs/core/testing/unit-testing-nunit-runner-intro.md docs/core/testing/unit-testing-nunit-runner-intro
docs/navigate/devops-testing/toc.yml docs/navigate/devops-testing/toc

@Youssef1313 Youssef1313 requested review from IEvangelist and a team as code owners February 26, 2025 12:04
@dotnetrepoman dotnetrepoman bot added this to the February 2025 milestone Feb 26, 2025
@dotnet-policy-service dotnet-policy-service bot added dotnet-fundamentals/svc community-contribution Indicates PR is created by someone from the .NET community. labels Feb 26, 2025
@Youssef1313
Copy link
Member Author

@gewarren @IEvangelist Could I get a review here please? Thanks!

Note: to better understand the ToC changes, you can turn off whitespace changes.

Youssef1313 and others added 2 commits February 28, 2025 19:51
@Youssef1313
Copy link
Member Author

Thanks so much for the review @gewarren and for the suggested improvements! I addressed all the comments. Is it good to merge now?

@gewarren gewarren merged commit 38bff04 into dotnet:main Mar 1, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-fundamentals/svc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants