[wp-trac] [WordPress Trac] #62196: Improve documentation for using the local Docker environment on Windows

[WordPress Trac]

#62196: Improve documentation for using the local Docker environment on Windows
----------------------------------------+-----------------------------
 Reporter:  desrosj                     |       Owner:  (none)
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  Future Release
Component:  Build/Test Tools            |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:
----------------------------------------+-----------------------------

Comment (by Clorith):

 As Windows has some particular quirks, especially when interacting with
 Linux images for Docker, it is generally recommended to use Windows
 Subsystem for Linux (WSL) if possible, or at least change the Docker
 engine to use Linux over Windows binaries, so ensure compatibility.

 Although there are some scenarios where running in experimental mode will
 let the environments load as intended, experimental is obviously not a
 great things to expect contributors to run. I've gathered together some
 suggested wording that can be added alongside the instructions for setting
 up a local environment in our readme:


 {{{
 #### Windows specific instructions

 For development on Windows, it is recommended to use the [Windows
 Subsystem for Linux (WSL)](https://learn.microsoft.com/en-
 us/windows/wsl/install), as this gives you access to a Linux environment,
 where the general recommendations and guides will work without any
 modifications.

 You will then only need to enable the docker WSL integration, this is
 found under "Settings > Resources > WSL integration", and is a one time
 operation the first time after you install Docker.


 If you wish to use Windows directly without WSL, start by installing
 Docker as in the previous instructions. Once the installation is
 completed, right click the Docker icon in your system tray, and choose the
 option "Switch to Linux containers...", and wait for Docker to restart. If
 this option is not present, or you only see "Switch to windows
 containers...", then you are already using the appropriate configuration,
 and can start your development environment. If you have other projects
 that rely on the Windows engine, you can easily swap back the same way.

 This switch to the Linux engine is to ensure that the development
 environment runs the same Docker images as the environments were built
 with, ensuring it works across all contributor environments
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/62196#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform