opensafely / opensafely/documentation

Improve documentation for installing docker on Windows Home

Open
#191 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improve content
Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

This is what the official docs have to say:

  • Hyper-V and Containers Windows features must be enabled.
  • The following hardware prerequisites are required to successfully run Client Hyper-V on Windows 10:
    • 64 bit processor with Second Level Address Translation (SLAT)
    • 4GB system RAM
    • BIOS-level hardware virtualization support must be enabled in the BIOS settings. For more information, see Virtualization.

Our test user has a "very late" build of Windows 10 Home: they went through the requirements trying to find out if they had SLAT. They added:

I couldn’t get the virtualization stuff to work either.

There were a series of more & more complex things for a simpleton like me to do with Hyper-V and Containers Windows. I also enabled WSL1 but didn’t get WSL2 to go.

I don’t know if I was close to getting it going, but each time I got something, I found there was another 2 levels to negotiate.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the official Docker for Windows Home installation documentation linked in the issue and locate the corresponding installation guidance in this repository. Clarify the Windows Home prerequisites, virtualization steps, and WSL guidance so a beginner can understand the required path and determine when installation is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.