Move "basic" prereqs and optional installation instructions to a global include file (#45380)

BillWagner · web-flow · commit b3e588c1871c · 2025-03-18T19:37:17.000-04:00
* Create prereq and install include files

Create two similar include files for the basic prerequisites used for many tutorials. One is intended for those tutorials where users likely haven't installed the prereqs, and includes instructions for getting them. The other is for those tutorials where more readers have likely installed .NET and skips that section.

* Add update prereqs where appropriate

Add the pre-reqs with installation instructions on selected tutorials where a significant number of readers have clicked the installation links.

* Replace list of prerequisites with the basic include file

In those tutorials where the list of prereqs matched the "basic" include file, but data showed that most readers don't click on the links to get the prereqs. That would indicate that those readers already have the necessary components.

* Include WinGet installation on Windows.

* fix build warnings
diff --git a/docs/core/install/windows.md b/docs/core/install/windows.md
@@ -167,7 +167,15 @@ For more information about, see [.NET SDK, MSBuild, and Visual Studio versioning
 
 ## Install with Visual Studio Code
 
-Visual Studio Code is a powerful and lightweight source code editor that runs on your desktop. Visual Studio Code can use the SDK already installed on your system. Additionally, the [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) extension will install .NET for you if it's not already installed.
+Visual Studio Code is a powerful and lightweight source code editor that runs on your desktop. Visual Studio Code can use the SDK already installed on your system.
+
+This [WinGet configuration file](https://builds.dotnet.microsoft.com/dotnet/install/dotnet_basic_config_docs.winget) installs the latest .NET SDK, Visual Studio Code and the C# DevKit. If you already have any of them installed, WinGet will skip that step.
+
+1. Download the file and double-click to run it.
+1. Read the license agreement, type <kbd>y</kbd>, and select <kbd>Enter</kbd> when prompted to accept.
+1. Be on the lookout for a flashing User Account Control (UAC) prompt in your Windows Taskbar, you may need to require administrator-level permissions to install.
+
+Additionally, the [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) extension will install .NET for you if it's not already installed.
 
 For instructions on installing .NET through Visual Studio Code, see [Getting Started with C# in VS Code](https://code.visualstudio.com/docs/csharp/get-started).
 
diff --git a/docs/core/testing/unit-testing-with-mstest.md b/docs/core/testing/unit-testing-with-mstest.md
@@ -13,7 +13,7 @@ This tutorial takes you through an interactive experience building a sample solu
 
 ## Prerequisites
 
-* The [.NET 6.0 SDK or later](https://dotnet.microsoft.com/download)
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Create the source project
 
diff --git a/docs/core/testing/unit-testing-with-nunit.md b/docs/core/testing/unit-testing-with-nunit.md
@@ -13,8 +13,7 @@ This tutorial takes you through an interactive experience building a sample solu
 
 ## Prerequisites
 
-- [.NET 8.0](https://dotnet.microsoft.com/download) or later versions.
-- A text editor or code editor of your choice.
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Creating the source project
 
diff --git a/docs/core/tutorials/creating-app-with-plugin-support.md b/docs/core/tutorials/creating-app-with-plugin-support.md
@@ -20,7 +20,7 @@ This tutorial shows you how to create a custom <xref:System.Runtime.Loader.Assem
 
 ## Prerequisites
 
-- Install the [.NET SDK](https://dotnet.microsoft.com/download).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Create the application
 
diff --git a/docs/core/tutorials/library-with-visual-studio-code.md b/docs/core/tutorials/library-with-visual-studio-code.md
@@ -13,11 +13,7 @@ When you create a class library, you can distribute it as a third-party componen
 
 ## Prerequisites
 
-* [Visual Studio Code](https://code.visualstudio.com/) with [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) installed.
-
-  For information about how to install extensions on Visual Studio Code, see [VS Code Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery).
-
-* The [.NET 9 SDK](https://dotnet.microsoft.com/download/dotnet/9.0).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic-winget.md)]
 
 ## Create a class library project
 
diff --git a/docs/core/tutorials/with-visual-studio-code.md b/docs/core/tutorials/with-visual-studio-code.md
@@ -9,11 +9,7 @@ This tutorial shows how to create and run a .NET console application by using Vi
 
 ## Prerequisites
 
-* [Visual Studio Code](https://code.visualstudio.com/) with [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) installed.
-
-  For information about how to install extensions on Visual Studio Code, see [VS Code Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery).
-
-* The [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic-winget.md)]
 
 ## Create the app
 
diff --git a/docs/csharp/asynchronous-programming/cancel-an-async-task-or-a-list-of-tasks.md b/docs/csharp/asynchronous-programming/cancel-an-async-task-or-a-list-of-tasks.md
@@ -19,11 +19,7 @@ This tutorial covers:
 
 ## Prerequisites
 
-This tutorial requires the following:
-
-- [.NET 5 or later SDK](https://dotnet.microsoft.com/download/dotnet/5.0)
-- Integrated development environment (IDE)
-  - [We recommend Visual Studio or Visual Studio Code](https://visualstudio.microsoft.com)
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ### Create example application
 
diff --git a/docs/csharp/fundamentals/tutorials/classes.md b/docs/csharp/fundamentals/tutorials/classes.md
@@ -9,7 +9,7 @@ In this tutorial, you'll build a console application and see the basic object-or
 
 ## Prerequisites
 
-[!INCLUDE [Prerequisites](../../includes/prerequisites.md)]
+[!INCLUDE [Prerequisites](../../../../includes/prerequisites-basic-winget.md)]
 
 ## Create your application
 
diff --git a/docs/csharp/fundamentals/tutorials/inheritance.md b/docs/csharp/fundamentals/tutorials/inheritance.md
@@ -10,7 +10,7 @@ This tutorial introduces you to inheritance in C#. Inheritance is a feature of o
 
 ## Prerequisites
 
-[!INCLUDE [Prerequisites](../../includes/prerequisites.md)]
+[!INCLUDE [Prerequisites](../../../../includes/prerequisites-basic-winget.md)]
 
 ## Running the examples
 
diff --git a/docs/csharp/fundamentals/tutorials/pattern-matching.md b/docs/csharp/fundamentals/tutorials/pattern-matching.md
@@ -17,7 +17,7 @@ In this tutorial, you'll learn how to:
 
 ## Prerequisites
 
-[!INCLUDE [Prerequisites](../../includes/prerequisites.md)]
+[!INCLUDE [Prerequisites](../../../../includes/prerequisites-basic-winget.md)]
 
 This tutorial assumes you're familiar with C# and .NET, including either Visual Studio or the .NET CLI.
 
diff --git a/docs/csharp/includes/prerequisites.md b/docs/csharp/includes/prerequisites.md
diff --git a/docs/csharp/tour-of-csharp/tutorials/index.md b/docs/csharp/tour-of-csharp/tutorials/index.md
@@ -41,6 +41,6 @@ This tutorial assumes that you've finished the lessons listed above.
 
 ## Set up your local environment
 
-After you finish these tutorials, set up a development environment.
+After you finish these tutorials, set up a development environment. You'll want:
 
-[!INCLUDE [Prerequisites](../../includes/prerequisites.md)]
+[!INCLUDE [Prerequisites](../../../../includes/prerequisites-basic-winget.md)]
diff --git a/docs/csharp/tutorials/console-teleprompter.md b/docs/csharp/tutorials/console-teleprompter.md
@@ -21,8 +21,7 @@ There are a lot of features in this tutorial. Let's build them one by one.
 
 ## Prerequisites
 
-- [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0).
-- A code editor.
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Create the app
 
diff --git a/docs/csharp/tutorials/console-webapiclient.md b/docs/csharp/tutorials/console-webapiclient.md
@@ -20,8 +20,7 @@ If you prefer to follow along with the [final sample](/samples/dotnet/samples/co
 
 ## Prerequisites
 
-* [.NET SDK 6.0 or later](https://dotnet.microsoft.com/download/dotnet/6.0)
-* A code editor such as [Visual Studio [Code](https://code.visualstudio.com/) (an open-source, cross-platform editor). You can run the sample app on Windows, Linux, or macOS, or in a Docker container.
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Create the client app
 
diff --git a/docs/csharp/tutorials/nullable-reference-types.md b/docs/csharp/tutorials/nullable-reference-types.md
@@ -19,7 +19,7 @@ In this tutorial, you'll learn how to:
 
 ## Prerequisites
 
-You'll need to set up your machine to run .NET, including the C# compiler. The C# compiler is available with [Visual Studio 2022](https://visualstudio.microsoft.com/downloads), or the [.NET SDK](https://dotnet.microsoft.com/download/dotnet).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 This tutorial assumes you're familiar with C# and .NET, including either Visual Studio or the .NET CLI.
 
diff --git a/docs/csharp/tutorials/patterns-objects.md b/docs/csharp/tutorials/patterns-objects.md
@@ -17,7 +17,7 @@ In this tutorial, you learn how to:
 
 ## Prerequisites
 
-You need to set up your machine to run .NET. Download [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or the [.NET SDK](https://dotnet.microsoft.com/download).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Build a simulation of a canal lock
 
diff --git a/docs/csharp/tutorials/records.md b/docs/csharp/tutorials/records.md
@@ -17,7 +17,7 @@ In this tutorial, you learn how to:
 
 ## Prerequisites
 
-You need to set up your machine to run .NET 6 or later. The C# compiler is available with [Visual Studio 2022](https://visualstudio.microsoft.com/vs) or the [.NET SDK](https://dotnet.microsoft.com/download).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Characteristics of records
 
diff --git a/docs/csharp/tutorials/top-level-statements.md b/docs/csharp/tutorials/top-level-statements.md
@@ -15,7 +15,7 @@ In this tutorial, you learn how to:
 
 ## Prerequisites
 
-You need to set up your machine to run .NET 6 or later. The C# compiler is available starting with [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or [.NET SDK](https://dot.net/get-dotnet6).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 This tutorial assumes you're familiar with C# and .NET, including either Visual Studio or the .NET CLI.
 
diff --git a/docs/csharp/tutorials/working-with-linq.md b/docs/csharp/tutorials/working-with-linq.md
@@ -26,7 +26,7 @@ This tutorial has multiple steps. After each step, you can run the application a
 
 ## Prerequisites
 
-You’ll need to set up your machine to run .NET core. You can find the installation instructions on the [.NET Core Download](https://dotnet.microsoft.com/download) page. You can run this application on Windows, Ubuntu Linux, or OS X, or in a Docker container. You’ll need to install your favorite code editor. The descriptions below use [Visual Studio Code](https://code.visualstudio.com/) which is an open source, cross-platform editor. However, you can use whatever tools you are comfortable with.
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Create the Application
 
diff --git a/docs/csharp/whats-new/tutorials/primary-constructors.md b/docs/csharp/whats-new/tutorials/primary-constructors.md
@@ -18,7 +18,7 @@ In this tutorial, you will learn:
 
 ## Prerequisites
 
-You need to set up your machine to run .NET 8 or later, including the C# 12 or later compiler. The C# 12 compiler is available starting with [Visual Studio 2022 version 17.7](https://visualstudio.microsoft.com/vs) or the [.NET 8 SDK](https://dotnet.microsoft.com/download).
+[!INCLUDE [Prerequisites](../../../../includes/prerequisites-basic.md)]
 
 ## Primary constructors
 
diff --git a/docs/csharp/whats-new/tutorials/static-virtual-interface-members.md b/docs/csharp/whats-new/tutorials/static-virtual-interface-members.md
@@ -18,7 +18,7 @@ In this tutorial, you'll learn how to:
 
 ## Prerequisites
 
-You'll need to set up your machine to run .NET 7, which supports C# 11. The C# 11 compiler is available starting with [Visual Studio 2022, version 17.3](https://visualstudio.microsoft.com/downloads/) or the [.NET 7 SDK](https://dotnet.microsoft.com/download).
+[!INCLUDE [Prerequisites](../../../../includes/prerequisites-basic.md)]
 
 ## Static abstract interface methods
 
diff --git a/docs/machine-learning/how-to-guides/install-model-builder.md b/docs/machine-learning/how-to-guides/install-model-builder.md
@@ -15,8 +15,7 @@ Learn how to install ML.NET Model Builder to add machine learning to your .NET a
 
 ## Prerequisites
 
-- Visual Studio 2022 or Visual Studio 2019.
-- .NET Core 3.1 SDK or later.
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ## Limitations
 
diff --git a/docs/orleans/quickstarts/build-your-first-orleans-app.md b/docs/orleans/quickstarts/build-your-first-orleans-app.md
@@ -26,8 +26,7 @@ At the end of the quickstart, you have an app that creates and handles redirects
 
 # [Visual Studio Code](#tab/visual-studio-code)
 
-- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
-- [Visual Studio Code](https://code.visualstudio.com/)
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 ---
 
diff --git a/docs/standard/commandline/get-started-tutorial.md b/docs/standard/commandline/get-started-tutorial.md
@@ -31,8 +31,7 @@ In this tutorial, you learn how to:
 
 ## Prerequisites
 
-* A code editor, such as [Visual Studio Code](https://code.visualstudio.com/) with the [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp).
-* The [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0).
+[!INCLUDE [Prerequisites](../../../includes/prerequisites-basic.md)]
 
 Or
 
diff --git a/includes/prerequisites-basic-winget.md b/includes/prerequisites-basic-winget.md
@@ -0,0 +1,24 @@
+---
+author: BillWagner
+ms.author: wiwagn
+ms.topic: include
+ms.date: 03/18/2025
+---
+
+- The latest [.NET SDK](https://dotnet.microsoft.com/download)
+- [Visual Studio Code](https://code.visualstudio.com) editor
+- The [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
+
+### Installation instructions
+
+On Windows, this [WinGet configuration file](https://builds.dotnet.microsoft.com/dotnet/install/dotnet_basic_config_docs.winget) to install all prerequisites. If you already have something installed, WinGet will skip that step.
+
+1. Download the file and double-click to run it.
+1. Read the license agreement, type <kbd>y</kbd>, and select <kbd>Enter</kbd> when prompted to accept.
+1. Be on the lookout for a flashing User Account Control (UAC) prompt in your Windows Taskbar, you may need to require administrator-level permissions to install.
+
+On other platforms, you need to install each of these components separately.
+
+1. Download the recommended installer from the [.NET SDK download page](https://dotnet.microsoft.com/download)and double-click to run it. The download page detects your platform and recommends the latest installer for your platform.
+1. Download the latest installer from the [Visual Studio Code](https://code.visualstudio.com) home page and double click to run it. That page also detects your platform and the link should be correct for your system.
+1. Click the "Install" button on the [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) extension page. That opens Visual Studio code, and asks if you want to install or enable the extension. Select "install".
diff --git a/includes/prerequisites-basic.md b/includes/prerequisites-basic.md
@@ -0,0 +1,10 @@
+---
+author: BillWagner
+ms.author: wiwagn
+ms.topic: include
+ms.date: 03/18/2025
+---
+
+- The latest [.NET SDK](https://dotnet.microsoft.com/download)
+- [Visual Studio Code](https://code.visualstudio.com) editor
+- The [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
