Conversation
docs/core/testing/microsoft-testing-platform-troubleshooting.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
This PR refactors the Microsoft.Testing.Platform (MTP) documentation to improve navigation and organization. It shifts from an extension-centric structure to a feature-centric structure, making it easier for users to find the information they need based on their goals rather than navigating through generic "extensions" categories.
Changes:
- Adds new test platforms overview page to help users choose between VSTest and MTP
- Reorganizes MTP documentation from extension categories to feature-specific pages (terminal output, test reports, code coverage, crash/hang dumps, retry, hot reload, fakes, OpenTelemetry, telemetry)
- Creates consolidated CLI options reference page
- Merges exit codes and FAQ content into unified troubleshooting page
- Splits architecture documentation into separate pages for test frameworks vs extensions
- Updates TOC for better navigation hierarchy
- Establishes comprehensive redirects for all renamed/deleted pages
Reviewed changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/core/testing/test-platforms-overview.md | New overview page to help users choose between VSTest and MTP platforms |
| docs/core/testing/microsoft-testing-platform-features.md | New feature overview page replacing generic extensions page |
| docs/core/testing/microsoft-testing-platform-cli-options.md | New consolidated CLI reference replacing scattered option documentation |
| docs/core/testing/microsoft-testing-platform-troubleshooting.md | New troubleshooting page consolidating exit codes and FAQ |
| docs/core/testing/microsoft-testing-platform-terminal-output.md | Feature-specific page extracted from extensions-output.md |
| docs/core/testing/microsoft-testing-platform-test-reports.md | Feature-specific page extracted from extensions-test-reports.md |
| docs/core/testing/microsoft-testing-platform-code-coverage.md | Feature-specific page extracted from extensions-code-coverage.md |
| docs/core/testing/microsoft-testing-platform-crash-hang-dumps.md | Feature-specific page extracted from extensions-diagnostics.md |
| docs/core/testing/microsoft-testing-platform-retry.md | Feature-specific page extracted from extensions-policy.md |
| docs/core/testing/microsoft-testing-platform-hot-reload.md | Feature-specific page extracted from extensions-hosting.md |
| docs/core/testing/microsoft-testing-platform-fakes.md | Feature-specific page from extensions-fakes.md |
| docs/core/testing/microsoft-testing-platform-open-telemetry.md | New OpenTelemetry feature page |
| docs/core/testing/microsoft-testing-platform-telemetry.md | Updated telemetry page with auto-registration info |
| docs/core/testing/microsoft-testing-platform-run-and-debug.md | Extracted run/debug content from intro page |
| docs/core/testing/microsoft-testing-platform-architecture-test-framework.md | Separated test framework architecture from extensions |
| docs/core/testing/microsoft-testing-platform-architecture-extensions.md | Refocused on extensions architecture only |
| docs/core/testing/microsoft-testing-platform-intro.md | Streamlined overview with navigation to other pages |
| docs/core/testing/migrating-vstest-microsoft-testing-platform.md | Updated links and fixed missing quote |
| docs/navigate/devops-testing/toc.yml | Reorganized TOC structure to match new organization |
| .openpublishing.redirection.core.json | Added comprehensive redirects for all moved/renamed pages |
| Various other files | Updated internal links to point to renamed pages |
meaghanlewis
left a comment
There was a problem hiding this comment.
These changes LGTM. Left a handful of suggestions for you to consider.
|
|
||
| Specifies the name of the response file. The response file name must immediately follow the @ character with no white space between the @ character and the response file name. | ||
|
|
||
| Options in a response file are interpreted as if they were present at that place in the command line. Each argument in a response file must begin and end on the same line. You cannot use the backslash character (\) to concatenate lines. Using a response file helps for very long commands that might exceed the terminal limits. You can combine a response file with inline command-line arguments. For example: |
There was a problem hiding this comment.
| Options in a response file are interpreted as if they were present at that place in the command line. Each argument in a response file must begin and end on the same line. You cannot use the backslash character (\) to concatenate lines. Using a response file helps for very long commands that might exceed the terminal limits. You can combine a response file with inline command-line arguments. For example: | |
| Options in a response file are interpreted as if they were present at that place in the command line. Each argument in a response file must begin and end on the same line. You can't use the backslash character `\` to concatenate lines. Using a response file helps for very long commands that might exceed the terminal limits. You can combine a response file with inline command-line arguments. For example: |
|
|
||
| - **`@`** | ||
|
|
||
| Specifies the name of the response file. The response file name must immediately follow the @ character with no white space between the @ character and the response file name. |
There was a problem hiding this comment.
| Specifies the name of the response file. The response file name must immediately follow the @ character with no white space between the @ character and the response file name. | |
| Specifies the name of the response file. The response file name must immediately follow the `@` character with no white space between the `@` character and the response file name. |
|
|
||
| - **`--diagnostic-synchronous-write`** | ||
|
|
||
| Forces the built-in file logger to synchronously write logs. Useful for scenarios where you don't want to lose any log entries (if the process crashes). This does slow down the test execution. |
There was a problem hiding this comment.
| Forces the built-in file logger to synchronously write logs. Useful for scenarios where you don't want to lose any log entries (if the process crashes). This does slow down the test execution. | |
| Forces the built-in file logger to synchronously write logs. Useful for scenarios where you don't want to lose any log entries (if the process crashes). This slows down the test execution. |
|
|
||
| - **`--list-tests`** | ||
|
|
||
| List available tests. Tests will not be executed. |
There was a problem hiding this comment.
| List available tests. Tests will not be executed. | |
| List available tests. Tests won't be executed. |
| These features require installing additional NuGet packages, as described in each section. | ||
|
|
||
| > [!TIP] | ||
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), these extensions are auto-registered when you install their NuGet packages — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
There was a problem hiding this comment.
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), these extensions are auto-registered when you install their NuGet packages — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. | |
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), these extensions are auto-registered when you install their NuGet packages — no code changes needed. The manual registration specified in this article is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
|
|
||
| - Find command-line switches in one place: [Microsoft.Testing.Platform CLI options reference](./microsoft-testing-platform-cli-options.md) | ||
| - Add capabilities to your test runs: use the feature pages in this article. | ||
| - Create your own extension: [Microsoft.Testing.Platform architecture](./microsoft-testing-platform-architecture.md), [Extension points](./microsoft-testing-platform-architecture-extensions.md), and [Services](./microsoft-testing-platform-architecture-services.md) |
There was a problem hiding this comment.
| - Create your own extension: [Microsoft.Testing.Platform architecture](./microsoft-testing-platform-architecture.md), [Extension points](./microsoft-testing-platform-architecture-extensions.md), and [Services](./microsoft-testing-platform-architecture-services.md) | |
| - Create your own extension: [Microsoft.Testing.Platform architecture](./microsoft-testing-platform-architecture.md), [Extension points](./microsoft-testing-platform-architecture-extensions.md), and [Services](./microsoft-testing-platform-architecture-services.md). |
| This feature requires the [Microsoft.Testing.Extensions.HotReload](https://nuget.org/packages/Microsoft.Testing.Extensions.HotReload) NuGet package. | ||
|
|
||
| > [!TIP] | ||
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
There was a problem hiding this comment.
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. | |
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration specified in this article is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
| This feature requires the [Microsoft.Testing.Extensions.Retry](https://nuget.org/packages/Microsoft.Testing.Extensions.Retry) NuGet package. | ||
|
|
||
| > [!TIP] | ||
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
There was a problem hiding this comment.
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. | |
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration in the following section is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
| This feature requires the [Microsoft.Testing.Extensions.Telemetry](https://nuget.org/packages/Microsoft.Testing.Extensions.Telemetry) NuGet package. | ||
|
|
||
| > [!TIP] | ||
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
There was a problem hiding this comment.
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. | |
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), this extension is auto-registered when you install its NuGet package — no code changes needed. The manual registration in the following section is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
| These features require installing additional NuGet packages, as described in each section. | ||
|
|
||
| > [!TIP] | ||
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), these extensions are auto-registered when you install their NuGet packages — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
There was a problem hiding this comment.
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), these extensions are auto-registered when you install their NuGet packages — no code changes needed. The manual registration below is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. | |
| > When using [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild) (included transitively by MSTest, NUnit, and xUnit runners), these extensions are auto-registered when you install their NuGet packages — no code changes needed. The manual registration specified in this article is only required if you disabled the auto-generated entry point by setting `<GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>`. |
Summary
Explain what are test platforms and how to choose the one to use. Add links to the test frameworks, because that's what people know and will use.
Also refactor MTP doc so that it's easier to browse and look for the info.
Internal previews
Toggle expand/collapse