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.

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

Added Documentation for Windows WSL2 Client Setup #5169

Merged
merged 2 commits into from
Jun 17, 2021

Conversation

rahulramesha
Copy link
Contributor

@rahulramesha rahulramesha commented Jun 16, 2021

Description

Documentation for helping setup Client environment in Windows WSL2

Fixes #5119

Type of change

Documentation

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@rahulramesha
Copy link
Contributor Author

@somangshu please let me know your thoughts

1. Clicking on Green button on the Bottom Left corner in VSCode
2. Selecting **Reopen Folder in WSL**

After this You can continue Setting up from [here](#pre-requisites). But make sure to have `Nodejs` and `npm` installed on the WSL Distro.
Copy link
Contributor

Choose a reason for hiding this comment

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

When we say nodejs and npm is required, Can we point them to possible documentation that shows how to check this and then install if missing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved that up and added a Documentation link.

somangshu
somangshu previously approved these changes Jun 16, 2021
Copy link
Contributor

@somangshu somangshu left a comment

Choose a reason for hiding this comment

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

LGTM

@jsartisan
Copy link
Contributor

@somangshu @rahulramesha One thing to add is: Make sure that project files are inside the ubuntu filesystem instead of the windows filesystem.

@rahulramesha
Copy link
Contributor Author

@jsartisan added that as well, please check once more.

@jsartisan
Copy link
Contributor

LGTM!

@rahulramesha rahulramesha requested a review from somangshu June 16, 2021 13:56
Copy link
Contributor

@somangshu somangshu left a comment

Choose a reason for hiding this comment

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

LGTM

@rahulramesha rahulramesha merged commit 4f140d4 into release Jun 17, 2021
@rahulramesha rahulramesha deleted the DOC-client-setup-on-wsl2 branch June 17, 2021 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Support WSL2!
3 participants