Add Windows build instructions to how-to-build.md #3578
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can you create a fork of Gravitino and use your own repo to create the PR? |
jtao1
reviewed
May 30, 2024
| ``` | ||
|
|
||
| 3. Save and quit in vim using `:wq`. | ||
|
|
There was a problem hiding this comment.
We should add
- Run
source ~/.bashrcto which updates the .bashrc file in your current shell session.
mchades
reviewed
May 30, 2024
|
|
||
| **On Ubuntu (WSL):** | ||
|
|
||
| Refer to chatGPT for specific instructions. Here are the steps: |
There was a problem hiding this comment.
Have these steps been validated locally?
There was a problem hiding this comment.
yes, I made it to install docker on WSL.
ok, I will close current pr and create another one. Thanks Qian! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
(Please outline the changes and how this PR fixes the issue.)
This pull request adds instructions for building Gravitino on Windows using the Windows Subsystem for Linux (WSL). The new section provides a detailed step-by-step guide to setting up the necessary environment and dependencies on Windows to successfully build and run Gravitino. Additionally, it includes specific instructions provided by minghuang and docs written by Junshen Tao, which have been tested and proven effective for building the project.
Why are the changes needed?
These changes are needed to provide Windows users with clear and concise instructions on how to build Gravitino using WSL. This expands the accessibility of the project to a wider audience who may be using Windows as their primary development environment. It addresses the need for comprehensive documentation that covers all major operating systems, including Windows.
Fixes: # (No specific issue)
Does this PR introduce any user-facing change?
No user-facing APIs or properties were changed. The addition is purely documentation, aimed at helping developers set up their environment on Windows using WSL.
How was this patch tested?
The documentation changes were reviewed for accuracy and clarity. The steps outlined were followed to ensure they work as described, using an environment set up with Windows 11 and Ubuntu 22.04 on WSL. The specific instructions provided by minghuang were used to successfully build the project, confirming their effectiveness.