From d0f245c21c8cffb4254fc8a6b3f531b270a76b04 Mon Sep 17 00:00:00 2001 From: Sarah Oslund Date: Wed, 17 Feb 2021 15:47:34 -0800 Subject: [PATCH] Renaming SDK extension to .NET Education Bundle SDK Install Tool --- Documentation/troubleshooting-sdk.md | 2 +- README.md | 2 +- vscode-dotnet-runtime-extension/README.md | 16 ++++++++-------- vscode-dotnet-sdk-extension/README.md | 4 ++-- vscode-dotnet-sdk-extension/package.json | 20 +++++--------------- 5 files changed, 17 insertions(+), 27 deletions(-) diff --git a/Documentation/troubleshooting-sdk.md b/Documentation/troubleshooting-sdk.md index c8a9b46cf7..5bacc96655 100644 --- a/Documentation/troubleshooting-sdk.md +++ b/Documentation/troubleshooting-sdk.md @@ -32,4 +32,4 @@ Learn more about configuring Visual Studio Code settings [here](https://code.vis ## Other Issues -Haven't found a solution? Check out our [open issues](https://github.com/dotnet/vscode-dotnet-runtime/issues). If you don't see your issue there, please file a new issue by evoking the `.NET SDK Install Tool: Report an issue with the .NET SDK Install Tool` command from Visual Studio Code. +Haven't found a solution? Check out our [open issues](https://github.com/dotnet/vscode-dotnet-runtime/issues). If you don't see your issue there, please file a new issue by evoking the `.NET Education Bundle SDK Install Tool: Report an issue with the .NET Education Bundle SDK Install Tool` command from Visual Studio Code. diff --git a/README.md b/README.md index 9684528a5f..438daee2d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # .NET Runtime and SDK Installation Tools -This repo contains two VS Code extensions, [vscode-dotnet-runtime](vscode-dotnet-runtime-extension/README.md) and [vscode-dotnet-sdk](vscode-dotnet-sdk-extension/README.md). The [vscode-dotnet-runtime](vscode-dotnet-runtime-extension/README.md) can be used to install the .NET runtime and is meant to be leveraged by other extensions which depend on the runtime. The.[vscode-dotnet-sdk](vscode-dotnet-sdk-extension/README.md) is a special install for internal features and not designed to be used by other extensions because it will conflict with existing SDK installations on the users machine. +This repo contains two VS Code extensions, [vscode-dotnet-runtime](vscode-dotnet-runtime-extension/README.md) and [vscode-dotnet-sdk](vscode-dotnet-sdk-extension/README.md). The [vscode-dotnet-runtime](vscode-dotnet-runtime-extension/README.md) can be used to install the .NET runtime and is meant to be leveraged by other extensions which depend on the runtime. The [vscode-dotnet-sdk](vscode-dotnet-sdk-extension/README.md) is a special install for internal features and not designed to be used by other extensions because it will conflict with existing SDK installations on the users machine. ## Contributing to Repository diff --git a/vscode-dotnet-runtime-extension/README.md b/vscode-dotnet-runtime-extension/README.md index a7dcfcb467..cf352a4e5e 100644 --- a/vscode-dotnet-runtime-extension/README.md +++ b/vscode-dotnet-runtime-extension/README.md @@ -4,17 +4,17 @@ This extension allows acquisition of the .NET runtime specifically for Visual Studio Code extension authors. This tool is intended to be leveraged in extensions that are written in .NET and require .NET to boot pieces of the extension (e.g. a language server). The extension is not intended to be used directly by users to install .NET for development. -## Goals: Acquiring .NET Core for extensions +## Goals: Acquiring .NET for extensions -Extension authors do not know if the .NET core runtime is installed on the target machine. Existing solutions have a number of challenges: +Prior to the release of this extension, extension authors had no way of knowing if the .NET runtime was installed on their target machines. Other solutions had a number of challenges: -1. **Duplication of .NET Core runtimes and slow updates**: Currently, each extension is acquiring its own copy of .NET core at ~30mb each. -2. **Clean up**: When extensions install .NET Core in a non-VSCode folder location it is likely to be left behind. -3. **Servicing and floating versions**: It is difficult to ensure that extensions will use the latest releases, particuarly without re-shipping. -4. **Corrupted installations**: Corrupted installations can arise when VS Code is shut down mid-download or unzip. -5. **Network security policies**: Alternative installation methods may result in errors due to blocking from network security policies. +1. **Duplication of .NET runtimes and slow updates**: Each extension was acquiring its own copy of .NET at ~30mb each. +2. **Clean up**: When extensions installed .NET in a non-VSCode folder location it was likely to be left behind. +3. **Servicing and floating versions**: It was difficult to ensure that extensions would use the latest releases, particuarly without re-shipping. +4. **Corrupted installations**: Corrupted installations could arise when VS Code was shut down mid-download or unzip. +5. **Network security policies**: Alternative installation methods could have resulted in errors due to blocking from network security policies. 6. **Locked down environments**: Some developers are unable to freely install software, requiring the ability to install extensions manually via a VSIX. -7. **Missing dependencies**: Users may run into situations where .NET Core cannot run as-is, requiring the installation of missing pieces. +7. **Missing dependencies**: Users may run into situations where .NET cannot run as-is, requiring the installation of missing pieces. This extension attempts to solve the above issues. diff --git a/vscode-dotnet-sdk-extension/README.md b/vscode-dotnet-sdk-extension/README.md index ef04e4dadc..2ac6c8ce0f 100644 --- a/vscode-dotnet-sdk-extension/README.md +++ b/vscode-dotnet-sdk-extension/README.md @@ -1,8 +1,8 @@ -# .NET SDK Install Tool +# .NET Education Bundle SDK Install Tool **Note: This is a very early preview of this tool and is not intended for use outside the .NET education bundle. Using this in other scenarios will result in broken installs on user machines due to conflict with the normal SDK installer.** -This extension allows acquisition of a local copy of the .NET SDK specifically for Visual Studio Code and the Education Bundle. The extension is not intended to be used directly by users to install .NET for development. +This extension allows acquisition of a local copy of the .NET SDK specifically for Visual Studio Code and the education bundle. The extension is not intended to be used directly by users to install .NET for development. ## .NET Foundation diff --git a/vscode-dotnet-sdk-extension/package.json b/vscode-dotnet-sdk-extension/package.json index fe3916036c..bd3a9c555b 100644 --- a/vscode-dotnet-sdk-extension/package.json +++ b/vscode-dotnet-sdk-extension/package.json @@ -9,7 +9,7 @@ }, "license": "MIT", "author": "Microsoft Corporation", - "displayName": ".NET SDK Install Tool", + "displayName": ".NET Education Bundle SDK Install Tool", "description": "Allows acquisition of the .NET SDK.", "icon": "images/dotnetIcon.png", "version": "0.0.1", @@ -38,27 +38,17 @@ "commands": [ { "command": "dotnet-sdk.reportIssue", - "title": "Report an issue with the .NET SDK Install Tool.", - "category": ".NET SDK Install Tool" - }, - { - "command": "dotnet-sdk.acquire", - "title": "Install the .NET SDK.", - "category": ".NET SDK Install Tool" - }, - { - "command": "dotnet-sdk.uninstallAll", - "title": "Uninstall all VS Code copies of .NET SDK.", - "category": ".NET SDK Install Tool" + "title": "Report an issue with the .NET Education Bundle SDK Install Tool.", + "category": ".NET Education Bundle SDK Install Tool" } ], "configuration": { - "title": ".NET SDK Install Tool", + "title": ".NET Education Bundle SDK Install Tool", "properties": { "dotnetSDKAcquisitionExtension.enableTelemetry": { "type": "boolean", "default": true, - "description": "Enable Telemetry for the .NET SDK install tool." + "description": "Enable Telemetry for the .NET Education Bundle SDK Install Tool." }, "dotnetSDKAcquisitionExtension.installTimeoutValue": { "type": "number",