Skip to content

[WIP] Initial LSTF Windows setup instructions update #861

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

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

froggleston
Copy link
Contributor

@froggleston froggleston commented Mar 31, 2025

This is a work in progress update to the Windows setup instructions to include WSL 2 for Windows 10 and 11 users.

Things left to do:

  • Screenshots/Images
  • Review

@froggleston froggleston changed the title [WIPInitial LSTF Windows setup instructions update [WIP] Initial LSTF Windows setup instructions update Mar 31, 2025
Copy link

netlify bot commented Mar 31, 2025

Deploy Preview for workshop-template-previews ready!

Name Link
🔨 Latest commit 2a34c50
🔍 Latest deploy log https://app.netlify.com/sites/workshop-template-previews/deploys/67f003d16933be0008daaa7c
😎 Deploy Preview https://deploy-preview-861--workshop-template-previews.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@tobyhodges tobyhodges left a comment

Choose a reason for hiding this comment

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

Thanks @froggleston 🙌 Your descriptions and explanations are clear but my overall impression is that this is too long and might be intimidating for some novices. (Screenshots are necessary but are going to make it longer still.)

I wonder if we can use nested tabsets, e.g. to display the WSL instructions by default with a separate tab for Git for Windows? Or a lower-tech option might be some details elements to collapse some of the blocks down?

Comment on lines 91 to 99
Linux comes in many flavours, called <a href="https://en.wikipedia.org/wiki/Linux_distribution">“distributions”</a>, and each has its own benefits, features and quirks!
</p>

<p>
WSL 2 is a fully fledged Linux environment that runs completely within your Windows 10 or 11 operating system.
While there are many Linux distributions available to install (e.g. Ubuntu, Debian, Fedora, Mint, Arch, Gentoo, and hundreds more!), WSL 2 only supports a handful of distributions listed above due to the way it needs to be integrated with Windows itself.
</p>
<p>
So, we will use the default that WSL 2 recommends, Ubuntu.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Linux comes in many flavours, called <a href="https://en.wikipedia.org/wiki/Linux_distribution">“distributions”</a>, and each has its own benefits, features and quirks!
</p>
<p>
WSL 2 is a fully fledged Linux environment that runs completely within your Windows 10 or 11 operating system.
While there are many Linux distributions available to install (e.g. Ubuntu, Debian, Fedora, Mint, Arch, Gentoo, and hundreds more!), WSL 2 only supports a handful of distributions listed above due to the way it needs to be integrated with Windows itself.
</p>
<p>
So, we will use the default that WSL 2 recommends, Ubuntu.
Linux comes in many flavours, called <a href="https://en.wikipedia.org/wiki/Linux_distribution">“distributions”</a>, and each has its own benefits, features and quirks! We will use the default that WSL 2 recommends, Ubuntu.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've reduced the overall length of visible text and it's more digestible now I think. I added some details blocks to remove extra text that wasn't really required, but could help if people needed it.

Comment on lines 102 to 103
Install Ubuntu either via the <a href="#shell-windows-wsl-store">Microsoft Store</a>, or from within the <a href="#shell-windows-wsl-powershell">Windows Powershell</a> command prompt.
There are also <a href="https://learn.microsoft.com/en-gb/windows/wsl/install">full instructions</a> on the Microsoft website.
Copy link
Member

Choose a reason for hiding this comment

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

Can we pick one of these, in the interest of cutting down the length a bit?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As discussed, I removed powershell instructions and kept the link to the full instructions on Microsoft's site if people were comfortable with that route.

Comment on lines 152 to 166
<p>
The first thing to do is to update the package manager's list of available packages. To do this in Ubuntu, we use a tool called <code>apt</code>.
Type the following command into the bash prompt:
<code>sudo apt update</code>
</p>
<p>
<strong>Note:</strong> You will be prompted to enter your password. This is the password you set when installing Ubuntu, and will not show up on the screen as you type it in.
This is a security feature of the terminal, and is normal behaviour.
</p>
<p>
Install updated versions of packages required across all our lessons, by typing:
<ul>
<li><code>sudo apt-get install git build-essential autotools python3 r-base</code></li>
</ul>
</p>
Copy link
Member

Choose a reason for hiding this comment

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

Would you expect apt update to take a long time to run here? I genuinely have no idea but if so, I think it's worth including a comment that this is expected.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm yes it might if the connection is slow. I'll add a note in.

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.

2 participants