From b842d3fcde0fdcc51d57101ced8e1d4efd611fcd Mon Sep 17 00:00:00 2001 From: Tony Sansone Date: Mon, 2 Oct 2023 12:24:00 -0500 Subject: [PATCH] Added part of the desktop revisions --- .../docs/install/admonitions/install-paths.md | 12 +++++++++ .../docs/install/flutter/download.md | 24 +++++++----------- src/_includes/docs/install/flutter/vscode.md | 25 ++++++++++++++++++- .../docs/install/reqs/windows/base.md | 9 ++++--- 4 files changed, 50 insertions(+), 20 deletions(-) create mode 100644 src/_includes/docs/install/admonitions/install-paths.md diff --git a/src/_includes/docs/install/admonitions/install-paths.md b/src/_includes/docs/install/admonitions/install-paths.md new file mode 100644 index 00000000000..00f57b6ae17 --- /dev/null +++ b/src/_includes/docs/install/admonitions/install-paths.md @@ -0,0 +1,12 @@ + + {{site.alert.warning}} + + Don't install Flutter to a directory or path that meets + one or both of the following conditions: + + * The path contains special characters or spaces. + * The path requires elevated privileges. + + As an example, `C:\Program Files\` fails both conditions. + + {{site.alert.end}} diff --git a/src/_includes/docs/install/flutter/download.md b/src/_includes/docs/install/flutter/download.md index a05029aadc0..80da33bb84c 100644 --- a/src/_includes/docs/install/flutter/download.md +++ b/src/_includes/docs/install/flutter/download.md @@ -12,32 +12,26 @@ {% endif -%} 1. Download the following installation bundle to get the latest - {{site.sdk.channel}} release of the Flutter SDK: + {{site.sdk.channel}} release of the Flutter SDK. [(loading...)](#){:.download-latest-link-{{osl}}.btn.btn-primary} For other release channels, and older builds, check out the [SDK archive][]. -1. Extract the zip file. +1. Create a folder where you can install Flutter. - ```terminal - {{unzip}} [(loading...)](#){:.download-latest-link-{{osl}}} - ``` + Consider `%USERPROFILE%` or `D:\dev`. -1. Move the contained `flutter` directory - to where you want to store the Flutter SDK. + {% include docs/install/admonitions/install-paths.md %} - {{site.alert.warning}} - Do not install Flutter to a directory or path that meets - one or both of the following conditions: +1. Move the zip file into the directory you want to store the Flutter SDK. - - The path contains special characters or spaces. - - The path requires elevated privileges. +1. Extract the zip file. - As an example, `C:\Program Files\` fails both conditions. - You could use `%USERPROFILE%\flutter` or `D:\dev\flutter`. - {{site.alert.end}} + ```terminal + {{unzip}} {:.download-latest-link-{{osl}}} + ``` [SDK archive]: {{site.url}}/release/archive diff --git a/src/_includes/docs/install/flutter/vscode.md b/src/_includes/docs/install/flutter/vscode.md index ba542afcfdf..b7baf38bd95 100644 --- a/src/_includes/docs/install/flutter/vscode.md +++ b/src/_includes/docs/install/flutter/vscode.md @@ -4,6 +4,8 @@ #### Start Flutter install {:.no_toc} +1. Open VS Code. + 1. To open the Command Palette, press Control + Shift + P. @@ -13,6 +15,7 @@ 1. VS Code prompts you to locate the Flutter SDK on your computer. + {:type="a"} 1. If you have the Flutter SDK installed, click **Locate SDK**. 1. If you do not have the Flutter SDK installed, click **Download SDK**. @@ -20,6 +23,10 @@ This option sends you the Flutter install page if you have not installed Git for Windows as directed in the [development tools prerequisites][]. +1. When prompted **Which Flutter template?**, ignore it. + Press Esc. + You can create a test project after checking your development setup. + #### Download the Flutter SDK {:.no_toc} @@ -29,6 +36,10 @@ VS Code places you in your user profile to start. Choose a different location. + Consider `%USERPROFILE%` or `D:\dev`. + + {% include docs/install/admonitions/install-paths.md %} + 1. Click **Clone Flutter**. While downloading Flutter, a notification displays: @@ -37,6 +48,10 @@ Downloading the Flutter SDK. This may take a few minutes. ``` + This download takes a few minutes. + If you suspect that the download has hung, click **Cancel** then + start the installation again. + 1. Once it finishes downloading Flutter, the **Output** panel displays. ```terminal @@ -67,7 +82,9 @@ Downloading windows-x64/font-subset tools... ``` - This process also runs `flutter doctor -v`. _Ignore this output._ + This process also runs `flutter doctor -v`. + At this point in the procedure, _ignore this output._ + Flutter Doctor might show errors that don't apply to this quick start. When the Flutter install succeeds, a notification displays: @@ -88,4 +105,10 @@ If you agree, click **OK**. +1. To enable `flutter` in all terminal windows: + + {:type="a"} + 1. Close, then reopen all Powershell windows. + 1. Restart VS Code. + [development tools prerequisites]: #development-tools diff --git a/src/_includes/docs/install/reqs/windows/base.md b/src/_includes/docs/install/reqs/windows/base.md index 5a71c9c318e..995f9c80da2 100644 --- a/src/_includes/docs/install/reqs/windows/base.md +++ b/src/_includes/docs/install/reqs/windows/base.md @@ -36,14 +36,15 @@ These versions of Windows should include the required Download and install the Windows version of the following packages: - [Git for Windows][] {{site.appmin.github_win}} or later to manage source code. -- [Visual Studio Code][] {{site.appmin.vscode}} or later - and the [Flutter extension][] to edit and debug Flutter code. +- [Visual Studio Code][] {{site.appmin.vscode}} or later to write code. {% include docs/install/reqs/windows/software.md target=include.target %} -Flutter doesn't support any of these packages. +The developers of the preceding software provide support for those products. To troubleshoot installation issues, consult that product's documentation. +Install the [Flutter extension for VS Code][] to edit and debug Flutter code. + [Visual Studio Code]: https://code.visualstudio.com/docs/setup/windows -[Flutter extension]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter +[Flutter extension for VS Code]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter [Windows PowerShell]: https://docs.microsoft.com/powershell/scripting/install/installing-windows-powershell [Git for Windows]: https://gitforwindows.org/