swiftlang / swift-org-website

Swift.org website
https://swift.org
Other
471 stars 179 forks source link

Order of installs for Windows is not specified #286

Open gandalfas opened 1 year ago

gandalfas commented 1 year ago

Issue Description

The Traditional Installation instructions for Windows on Getting Started do not specify the order of installs.

In my install, for various reasons, I chose to do the Traditional Install, even though I was installing 5.6.1. In that section there is no explicit step to install Swift after the dependencies, but under "Traditional", in the paragraph starting "Swift has been tested with VS 2019", the Download section was referenced before the big box describing the VS components. Because of that, with no other explicit ordering in the instructions, I installed Swift first, then proceeded to install the dependencies. This led to many problems.

Later I noticed that Swift should be installed as the last step. For example, in section "On Windows > Install using Scoop", installing Swift clearly follows installing the dependencies. And similarly, on page pwsacademy swift-setup, it says to install Swift after the dependencies.

Requested Change

This is for page Getting Started. Assuming that you will be keeping the Traditional Instructions for some time to come...

1. In section: Installing Swift > On Windows > Installation Instructions > Traditional Installation:

change this: Swift has been tested with Visual Studio 2019. You will need to install Visual Studio with the following components. <<The installer for Swift is available in the Download section. The toolchain on Windows is installed to %SystemDrive%\Library\Developer\Toolchains.>>

to this:

Swift has been tested with Visual Studio 2019. You will need to install Visual Studio with the following components.

. 2. Then just below, insert the following, just above 'Support Files', in order to place it right at the spot you need it (these details are akin to the macOS notes above):

Next install Swift. The installer for Swift is available in the Download section.

The toolchain on Windows is installed to %SystemDrive%\Library\Developer\Toolchains.

This install creates the env var: SDKROOT=C:\Library\Developer\Platforms\Windows.platform\Developer\SDKs\Windows.sdk

and it adds three directories to the end of the PATH env var: C:\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin C:\Library\Swift-development\bin C:\Library\icu-69.1\usr\bin

. 3. In Support Files, change this sentence:

You must use the x64 Native Tools for VS2019 Command Prompt to run the following steps.

to this:

You must use the x64 Native Tools for VS2019 Command Prompt, run as Administrator, to run the following steps.

Related Issue

This was originally submitted as 58451.

Environment details

Desktop

gandalfas commented 11 months ago

@shahmishal and @kaishin, in the massive work done in #354 (and THANKS for all that effort!!), I was hoping my items 1 and 2 described above might be addressed (item 3 was addressed, and thanks for that!).

Could it be that my error (not installing dependencies first) is rare because most people would just know that? (I described what led me to that in my second paragraph, at the top).

I'd appreciate your thoughts. Please excuse any wrong expectations, I am new to many github procedures. If you are not the appropriate people to ask, please send guidance on that.

Thanks!

alexandersandberg commented 11 months ago

@gandalfas we are soon merging some improvements to the Windows instructions in #385. Would be great if you could take a look at those changes to see if you're still having issues. 🙂

gandalfas commented 11 months ago

@alexandersandberg, thanks, I will!