Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Windows compatibility with Makefile #308 #309

Merged
merged 3 commits into from
Apr 24, 2023
Merged

[BUG] Windows compatibility with Makefile #308 #309

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18b6116
Added guides for Windows developers
Tokesh Apr 20, 2023
07bba27
fixing misstakes in documentation
Tokesh Apr 21, 2023
27fc230
fixing english misstakes
Tokesh Apr 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any new section needs to be added to TOC.


If you have a problem with running 'Make' follow this steps:

1. Install WSL2 (compatibility layer for running Linux applications on Windows 10).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should just add a "Windows" section to prerequisites, with links/instructions to install/download WSL and ensure make works.

Copy link
Contributor Author

@Tokesh Tokesh Apr 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


2. From Terminal choose your path to OpenSearch project and run WSL2.
```
wsl
```
3. Install 'Make' if you haven't done this before
```
sudo apt install make
```

## Lint

To keep all the code in a certain uniform format, it was decided to use some writing rules. If you wrote something wrong, it's okay, you can simply run the script to check the necessary files, and optionally format the content. But keep in mind that all these checks are repeated on the pipeline, so it's better to check locally.
Expand Down