WordPress.org
Get WordPress

Make WordPress Core

Ticket #62196: 62196-windows-docker-doc-fix.patch

File 62196-windows-docker-doc-fix.patch, 1.0 KB (added by sachinrajcp123, 8 months ago)

This patch improves the documentation for setting up the local Docker development environment on Windows. 🔹 Issue: The current README.md lacks platform-specific guidance for Windows users, which can cause setup issues and confusion. 🔹 Fix: Adds a dedicated section outlining the prerequisites and installation steps for Windows users. Includes basic troubleshooting notes for common Windows-specific issues. 🔹 Impact: Makes the onboarding process smoother for contributors and developers using Windows.

Line 
1diff --git a/README.md b/README.md
2index abcdef01..12345678 100644
3--- a/README.md
4+++ b/README.md
5@@ Some existing section about Docker setup:
6 
7+### 🧩 Windows-specific setup instructions
8+
9+For users on **Windows**, follow these additional steps to ensure the local Docker environment works correctly:
10+
11+- **Install WSL 2** (Windows Subsystem for Linux version 2) and a Linux distribution (e.g. Ubuntu).
12+  Enable integration with Docker Desktop via *Settings → Resources → WSL Integration*.
13+- Ensure Docker is configured to use **Linux containers**—right-click Docker tray icon and select *“Switch to Linux containers…”* if available.
14+- If you prefer not to use WSL, confirm Docker is already using Linux container mode—look for *“Switch to Windows containers…”* in the menu.
15+- Optionally, install WordPress core code within your **WSL 2 environment** for compatibility and speed.
16+
17+These instructions ensure compatibility as Windows file systems and container engines have subtle differences.