Retire Duplicate Documentation (#4341)

Retire duplicate documentation by redirecting to docs that will be updated. fixes #515 --------- Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
dotnet · Oct 19, 2023 · a663000 · a663000
1 parent 6e5d61e
commit a663000
Show file tree

Hide file tree

Showing 14 changed files with 30 additions and 3 deletions.
diff --git a/documentation/debugging-coredump.md b/documentation/debugging-coredump.md
@@ -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
 ==================================
 

diff --git a/documentation/design-docs/dotnet-tools.md b/documentation/design-docs/dotnet-tools.md
@@ -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
 

diff --git a/documentation/design-docs/eventcounters.md b/documentation/design-docs/eventcounters.md
@@ -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.
+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.
diff --git a/documentation/dotnet-counters-instructions.md b/documentation/dotnet-counters-instructions.md
@@ -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.
+        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.
diff --git a/documentation/dotnet-dump-instructions.md b/documentation/dotnet-dump-instructions.md
@@ -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)
 ==================================================
 

diff --git a/documentation/dotnet-gcdump-instructions.md b/documentation/dotnet-gcdump-instructions.md
@@ -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.

diff --git a/documentation/dotnet-trace-instructions.md b/documentation/dotnet-trace-instructions.md
@@ -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.

diff --git a/documentation/installing-sos-instructions.md b/documentation/installing-sos-instructions.md
@@ -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
 =================================
 

diff --git a/documentation/installing-sos-windows-instructions.md b/documentation/installing-sos-windows-instructions.md
@@ -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
 =========================
 

diff --git a/documentation/sos.md b/documentation/sos.md
@@ -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 
 ===
 

diff --git a/documentation/tutorial/app_is_leaking_memory_eventual_crash.md b/documentation/tutorial/app_is_leaking_memory_eventual_crash.md
@@ -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}

diff --git a/documentation/tutorial/app_running_slow_highcpu.md b/documentation/tutorial/app_running_slow_highcpu.md
@@ -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}

diff --git a/documentation/tutorial/hung_app.md b/documentation/tutorial/hung_app.md
@@ -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._** 

diff --git a/documentation/tutorial/installing_the_diagnostics_tools.md b/documentation/tutorial/installing_the_diagnostics_tools.md
@@ -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.
-Original file line number
+Diff line change
@@ -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
     ===
@@ Expand Down @@