Skip to content

Commit 5687685

Browse files
authored
Merge pull request #5080 from vitorfloriano/windows-docs
📖 add note about Windows support
2 parents 8ed1c38 + bb0ff85 commit 5687685

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,9 @@ Before starting any work, please either comment on an existing issue or file a n
130130

131131
## Operating Systems Supported
132132

133-
Currently, Kubebuilder officially supports macOS and Linux platforms. If you are using a Windows OS, you may encounter issues.
134-
Contributions towards supporting Windows are welcome.
133+
Currently, Kubebuilder officially supports macOS and Linux platforms. If you are using a Windows OS, we recommend you read the instructions in [here](docs/windows.md).
134+
135+
Contributions towards supporting Windows are not planned.
135136

136137
## Versions Compatibility and Supportability
137138

docs/windows.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Windows Support
2+
3+
Since no efforts have been made to add support for Windows in the past couple of years, we have decided not to pursue native Windows support at this time, considering both the additional maintenance overhead it adds to the project and the limited community contributions in that area.
4+
5+
That said, it’s still possible to use and contribute to Kubebuilder on a Windows machine by using WSL2 (Windows Subsystem for Linux) together with Docker Desktop.
6+
7+
- Learn more about setting up WSL2 in the [official docs](https://learn.microsoft.com/en-us/windows/wsl/).
8+
- The [Docker Desktop documentation](https://docs.docker.com/desktop/features/wsl/) has instructions on how to set up Docker to use WSL2 as the backend on Windows.
9+
- You can also learn more about setting up kind with Docker on WSL2 in the [kind official documentation](https://kind.sigs.k8s.io/docs/user/using-wsl2/).
10+
11+
All other dependencies and environment settings can be set up by following the Linux instructions.

0 commit comments

Comments
 (0)