Retire Duplicate Documentation (#4341)
authormikelle-rogers <45022607+mikelle-rogers@users.noreply.github.com>
Thu, 19 Oct 2023 21:49:51 +0000 (14:49 -0700)
committerGitHub <noreply@github.com>
Thu, 19 Oct 2023 21:49:51 +0000 (14:49 -0700)
Retire duplicate documentation by redirecting to docs that will be updated.

fixes #515

---------

Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
14 files changed:
documentation/debugging-coredump.md
documentation/design-docs/dotnet-tools.md
documentation/design-docs/eventcounters.md
documentation/dotnet-counters-instructions.md
documentation/dotnet-dump-instructions.md
documentation/dotnet-gcdump-instructions.md
documentation/dotnet-trace-instructions.md
documentation/installing-sos-instructions.md
documentation/installing-sos-windows-instructions.md
documentation/sos.md
documentation/tutorial/app_is_leaking_memory_eventual_crash.md
documentation/tutorial/app_running_slow_highcpu.md
documentation/tutorial/hung_app.md
documentation/tutorial/installing_the_diagnostics_tools.md

index eb43cee1661ead4451065779ff9380806833022e..4cfb0e33e9c603fcb082d6cef8446123bc244163 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now located at [debug-linux-dumps](https://learn.microsoft.com/dotnet/core/diagnostics/debug-linux-dumps) This doc is no longer being updated.
+
 Debugging Linux or MacOS Core Dump
 ==================================
 
index 0af1b58b44a740b8fe152a034906fb6b74d9f795..bd36698d01e4113b0dbfbbb81f9628e88dbf2e93 100644 (file)
@@ -1,4 +1,5 @@
-# Dotnet Diagnostic Tools CLI Design
+For the latest public documentation on using dotnet-* diagnostic tools see [dotnet-trace](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-trace), [dotnet-counters](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-counters), [dotnet-dump](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-dump), [dotnet-gcdump](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-gcdump), [dotnet-dsrouter](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-dsrouter), [dotnet-monitor](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-monitor), [dotnet-symbol](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-symbol), [dotnet-sos](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-sos).
+# Dotnet Diagnostic Tools CLI Design 
 
 ## User workflows
 
index 2815eca2c942347f4c915956947ced16e791b2f4..0cbd98fe2e55d0ed62f8000f47d8076be464e999 100644 (file)
@@ -1,3 +1,5 @@
+The newest documentation is now maintained at [eventcounters](https://learn.microsoft.com/dotnet/core/diagnostics/event-counters). This doc is no longer being updated.
+
 # EventCounters in .NET Core 3.0
 
 ## Introduction
@@ -332,4 +334,4 @@ The official dotnet-trace documentation contains a [section](https://github.com/
 
 TraceEvent is a managed library that makes it easy to consume ETW and EventPipe events. For more information, refer to the [TraceEvent Library Programmers Guide](https://github.com/Microsoft/perfview/blob/main/documentation/TraceEvent/TraceEventProgrammersGuide.md).
 
-For some more detailed code samples, you can also try reading [Criteo Labs blog](https://medium.com/criteo-labs/net-core-counters-internals-how-to-integrate-counters-in-your-monitoring-pipeline-5354cd61b42e) on how to do this.
\ No newline at end of file
+For some more detailed code samples, you can also try reading [Criteo Labs blog](https://medium.com/criteo-labs/net-core-counters-internals-how-to-integrate-counters-in-your-monitoring-pipeline-5354cd61b42e) on how to do this.
index 4faf0868b47373cb280c6d86dd1793149bd5bdea..86beeba17c4c8119cc195fe0f97ecefe69e32aa4 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained here: [dotnet-counters](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-counters). This doc is no longer being updated.
+
 # dotnet-counters
 
 NOTE: This documentation page may contain information on some features that are still work-in-progress. For most up-to-date documentation on released version of `dotnet-counters`, please refer to [its official documentation](https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-counters) page.
@@ -209,4 +211,4 @@ $ dotnet-counters monitor --counters System.Runtime[assembly-count] -- my-aspnet
         provider and counter names, use the list command.
 
     -- <command> (for target applications running .NET 5.0 or later only)
-        After the collection configuration parameters, the user can append `--` followed by a command to start a .NET application with at least a 5.0 runtime. `dotnet-counters` will launch a process with the provided command and collect the requested metrics.
\ No newline at end of file
+        After the collection configuration parameters, the user can append `--` followed by a command to start a .NET application with at least a 5.0 runtime. `dotnet-counters` will launch a process with the provided command and collect the requested metrics.
index c75ac8a606bd5bdc82affcb020b925397b579584..b3ea9ab8fc64b86f96d494dfdc1a415408b9fa1b 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained at [dotnet-dump](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-dump). This doc is no longer being updated.
+
 Dump collection and analysis utility (dotnet-dump)
 ==================================================
 
index 078785bc83478355935b98b50d8d78b7d0b01a4e..7ecbc75e5833b0318b47a2d4a451feeb6f2c2a29 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained at [dotnet-gcdump](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-gcdump). This doc is no longer being updated.
+
 # Heap Analysis Tool (dotnet-gcdump)
 
 NOTE: This documentation page may contain information on some features that are still work-in-progress. For most up-to-date documentation on released version of `dotnet-gcdump`, please refer to [its official documentation](https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-gcdump) page.
index 154996a927d691f4316190b1110bae2e4a6268f4..4ad26dfe646552965dca2b94df532669fa4ca09b 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained at [dotnet-trace](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-trace). This doc is no longer being updated.
+
 # Trace for performance analysis utility (dotnet-trace)
 
 NOTE: This documentation page may contain information on some features that are still work-in-progress. For most up-to-date documentation on released version of `dotnet-trace`, please refer to [its official documentation](https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace) page.
index 4db1420e3268b62ac8c4f33e31b230895605bad4..620e5c9cc577ad17cc8803f23d3efd4be00d86cd 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained at [dotnet-sos](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-sos). This doc is no longer being updated.
+
 Installing SOS on Linux and MacOS
 =================================
 
index cbde73e79e3f17fbac6e5e668ae5a20b9b7861b1..923f29004c23447186d7da98335492e3a21506f4 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained at [dotnet-sos](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-sos). This doc is no longer being updated.
+
 Installing SOS on Windows
 =========================
 
index e4de62587d6658b2c68b8d5395f6915030764e68..45d83740c6ba964c2e2299bfb479319b03be7215 100644 (file)
@@ -1,3 +1,5 @@
+This documentation is now being maintained at [dotnet-sos](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-sos). This doc is no longer being updated.
+
 SOS 
 ===
 
index dc29ecf6f9effdd4dcee772935e24a503ab3195f..bb97c26f01fda99f5a0286b1c0dbdfe407520cf3 100644 (file)
@@ -1,3 +1,5 @@
+The newest documentation is now being maintained at [debug-memory-leak](https://learn.microsoft.com/dotnet/core/diagnostics/debug-memory-leak). This documentation is no longer being updated.
+
 # App is leaking memory (eventual crash/stops responding)
 
 http://localhost:5000/api/diagscenario/memleak/{kb}
index aa56ea3558087d83514a0dc98350df3988a62e4d..2fd8fef245c6147526c1b78ca46e697e6df8fb23 100644 (file)
@@ -1,3 +1,5 @@
+The newest documentation is now being maintained at [debug-highcpu](https://learn.microsoft.com/dotnet/core/diagnostics/debug-highcpu). This documentation is no longer being updated.
+
 # App is running slow (due to high CPU)
 
 http://localhost:5000/api/diagscenario/highcpu/{milliseconds}
index a4fa89f39068cdb440ef58f1794f86b63913bce0..3e05005629eafdf57d604f619b3e176f77c25bce 100644 (file)
@@ -1,3 +1,5 @@
+The newest documentation is now being maintained at [debug-deadlock](https://learn.microsoft.com/dotnet/core/diagnostics/debug-deadlock). This documentation is no longer being updated.
+
 # App stops responding
 
 **IMPORTANT: This tutorial uses API/methods available in dotnet core preview 5. These API/methods are _subject to change._** 
index e3efd27750bda5a31236e840560c8b6d5193681b..56bf5e78c81b1c23b9543dfdc7aad3819cfc8d0f 100644 (file)
@@ -1,3 +1,5 @@
+The newest documentation is now maintained at [dotnet-trace](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-trace), [dotnet-counters](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-counters), [dotnet-dump](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-dump), [dotnet-gcdump](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-gcdump), [dotnet-dsrouter](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-dsrouter), [dotnet-monitor](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-monitor), [dotnet-symbol](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-symbol), [dotnet-sos](https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-sos). This documentation is no longer being updated.
+
 # Installing the diagnostics tools
 
 Depending on the diagnostics scenario you will use one or more of the tools below to get to root cause. By default, these tools are installed to ~/.dotnet/tools.