Skip to content

Installation guide improvements (especially for Windows) #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Sep 15, 2023

Conversation

stevapple
Copy link
Contributor

@stevapple stevapple commented Sep 8, 2023

This PR refines the installation guides to make it nicer and clearer, especially for Windows.

Motivation:

The Windows installation guide now have WinGet and Scoop part messed up. Different installation options should be arranged into separate source files like the Linux ones.

Modifications:

  • Splits _winget.md, _scoop.md and _traditional.md from /install/windows/index.md;
  • Fixes various typos in /install;
  • Updates Python installation instruction;
  • Adds back some documentation pieces that were dropped accidentally;
  • Fixes code highlighting for CMD (batch instead of cmd) and PowerShell (powershell instead of pwsh);
  • Aligns the styling within installation guides;
  • Removes duplicated contents in /download that are referenced nowhere.

Result:

  • The /install/windows page is updated for accuracy and appearance, and the sources are structured more clearly.
  • macOS and Linux guides are slightly improved.
  • Unused duplicated contents in /download are removed.

@stevapple
Copy link
Contributor Author

stevapple commented Sep 8, 2023

CC @shahmishal. This PR is marked as draft simply because I didn’t build and preview it yet.

@stevapple stevapple mentioned this pull request Sep 8, 2023
5 tasks
@shahmishal
Copy link
Member

This looks great, I would also like to have @compnerd review the changes.

@stevapple stevapple changed the title Restructure Windows installation options General improvements to installation guides (especially Windows) Sep 8, 2023
@stevapple
Copy link
Contributor Author

stevapple commented Sep 8, 2023

Screenshot
Swift org - Windows Installation Options

@stevapple stevapple changed the title General improvements to installation guides (especially Windows) Installation guide improvements (especially for Windows) Sep 8, 2023
Copy link
Member

@compnerd compnerd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of all, I really like the splitting up of the rules into individual files. This makes it way better.

Secondly, I like the touch up with the warning class, it highlights those bits better.

Aside from the minor editorial bit, the Windows changes are a welcome change and look good to me.

@shahmishal
Copy link
Member

@swift-ci test

@stevapple
Copy link
Contributor Author

Anyone to merge?

@stevapple
Copy link
Contributor Author

@shahmishal @compnerd Can you help to merge this?

@compnerd
Copy link
Member

@stevapple I wish I could, but I don't have that right. Mishal is out for a bit. Perhaps @tomerd can help?

@tomerd
Copy link
Contributor

tomerd commented Sep 12, 2023

I'll let @shahmishal merge when back

@stevapple
Copy link
Contributor Author

We see increased numbers of posts regarding Windows installation on Swift Forums these days, so I wonder if @shahmishal can be back soon to avoid more users being confused. If Mishal is not available in a short time, may @tomerd merge it on behalf?

@shahmishal
Copy link
Member

LGTM! Thanks

@shahmishal shahmishal merged commit 1437bd5 into swiftlang:main Sep 15, 2023
@KimTheLearner
Copy link

KimTheLearner commented Sep 17, 2023

Thanks for all this great work! @shahmishal and @stevapple, if it's not too late, might you have a look at these and consider?

or reply as to why they won't be addressed?

Also, prior to the recent changes, the Getting Started page had an example of using LLDB, as part of the install. Did that get dropped? if so, could it be restored? Or, where did that get moved to?

Thanks!

@tomerd
Copy link
Contributor

tomerd commented Sep 18, 2023

cc @compnerd @stevapple ^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants