[BUG] Windows compatibility with Makefile #308 #309
Conversation
Signed-off-by: Niyazbek Torekeldi <78027392+Tokesh@users.noreply.github.com>
Tokesh
requested review from
dblock,
VijayanB,
VachaShah and
Jakob3xD
as code owners
DEVELOPER_GUIDE.md
Outdated
| @@ -68,6 +68,21 @@ In order to differentiate unit tests from integration tests, Go has a built-in m | |||
| make cluster.stop cluster.clean | |||
| ``` | |||
|
|
|||
| #### Compatibility with Windows OS | |||
There was a problem hiding this comment.
Any new section needs to be added to TOC.
DEVELOPER_GUIDE.md
Outdated
|
|
||
| If you have a problem with running 'Make' follow this steps: | ||
|
|
||
| 1. Install WSL2 (compatibility layer for running Linux applications on Windows 10). |
There was a problem hiding this comment.
I think you should just add a "Windows" section to prerequisites, with links/instructions to install/download WSL and ensure make works.
There was a problem hiding this comment.
I think you should just add a "Windows" section to prerequisites, with links/instructions to install/download WSL and ensure make works.
I think i got it, fixed that in new commit. I tried to make it shorter like you said in Issue discussion
Tokesh
force-pushed
the
windows-compatibility
branch
from
7e65389 to
18b6116
Compare
Signed-off-by: Niyazbek Torekeldi <78027392+Tokesh@users.noreply.github.com>
DEVELOPER_GUIDE.md
Outdated
| @@ -32,6 +33,15 @@ OpenSearch Go Client builds using [Go](https://golang.org/doc/install) 1.11 at a | |||
|
|
|||
| [Docker](https://docs.docker.com/install/) is required for building some OpenSearch artifacts and executing integration tests. | |||
|
|
|||
| #### Windows | |||
|
|
|||
| [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) is compatibility layer for running Linux applications on Windows. | |||
There was a problem hiding this comment.
Missing "the", but let's say "To build the project on Windows, use WSL2, the compatibility ...".
There was a problem hiding this comment.
The first phrase needs some english fixing :) Thanks for hanging in here with me!
I appreciate that you are patient with me and I am glad to work together with you!
DEVELOPER_GUIDE.md
Outdated
|
|
||
| [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) is compatibility layer for running Linux applications on Windows. | ||
|
|
||
| Make ensure that you install 'Make' on WSL2. |
Signed-off-by: Niyazbek Torekeldi <78027392+Tokesh@users.noreply.github.com>
Description
I added guidelines for Windows developers in the Developer Guide (to use WSL2 and how to use WSL)
Issues Resolved
[#308 ]
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.