Adding sugestions to install WSL2 and it packages in environment-setup.md #2400

tpmai22 · 2021-10-26T23:07:51Z

Issue This PR Addresses

Type of Change

Bugfix: Change which fixes an issue
New Feature: Change which adds functionality
Documentation Update: Change which improves documentation
UI: Change which improves UI

Description

When I try to install redis using my newly installed WSL2, the installation was not succedded since my WSL2 have not updated yet. Running sudo apt update will get your WSL2 update so I think adding it in the doc might help other newly contributors as well.

Checklist

Quality: This PR builds and passes our npm test and works locally
Tests: This PR includes thorough tests or an explanation of why it does not
Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

humphd · 2021-10-26T23:13:06Z

docs/environment-setup.md

@@ -35,8 +35,9 @@ There are two methods to install Redis on Windows. We strongly recommend the fir
 ##### Option 1: Using [WSL2 (Windows Subsystem Linux)](https://docs.microsoft.com/en-us/windows/wsl/about)

 1. Follow Microsoft WSL2 [installation guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to complete the installation
-2. Depending on the distribution you chose for WSL2, install redis using that distro's package manager. For example, if using Ubuntu, run `sudo apt-get install redis`
+2. Depending on the distribution you chose for WSL2, install redis using that distro's package manager. For example, if using Ubuntu, run `sudo apt-get install redis` . Note: make sure to run `sudo apt update` after WSL2 has been installed.


I would move this note to the end of the first step vs. here. You might also mention upgrading:

# fetch updated package lists sudo apt update # upgrade installed/outdated packages sudo apt upgrade

humphd · 2021-10-26T23:13:43Z

docs/environment-setup.md

 3. Suggest to install [Windows Terminal](https://docs.microsoft.com/en-us/windows/wsl/install-win10#install-windows-terminal-optional), it facilitates you to switch directories between WSL2 Ubuntu bash and Windows drive
+4. Suggest to install [Node for WSL2](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl), so you can type node cml using WSL2 terminal


What is cml?

I mean command line but you're right it did not useful for the reader. I just upload another attempt on this if you have some time to take a look

Grommers00 · 2021-10-27T15:41:18Z

docs/environment-setup.md

@@ -34,9 +34,18 @@ There are two methods to install Redis on Windows. We strongly recommend the fir

 ##### Option 1: Using [WSL2 (Windows Subsystem Linux)](https://docs.microsoft.com/en-us/windows/wsl/about)

-1. Follow Microsoft WSL2 [installation guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to complete the installation
-2. Depending on the distribution you chose for WSL2, install redis using that distro's package manager. For example, if using Ubuntu, run `sudo apt-get install redis`
+1. Follow Microsoft WSL2 [installation guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to complete the installation.Suggest to run the following


Nit: Let us add a space between installation.Suggest

docs/environment-setup.md

Grommers00 · 2021-10-27T15:46:59Z

docs/environment-setup.md

+sudo apt upgrade
+```
+
+2. Depending on the distribution you chose for WSL2, install redis using that distro's package manager. For example, if using Ubuntu, run `sudo apt-get install redis` .


Can we include a list of the different Redis installs based on the different distros? Or at least a link where someone can quickly find which one they need.

@Grommers00 I just made an attempt base on your comment. Would you mind to check and see if it will beneficial for new contributors to set up the environment ?

Looks good :D, I think just periods need to be added.

@Grommers00 @cindyledev if you guys feel like having more details for the newbies, kindly let me know

docs/environment-setup.md

HyperTHD · 2021-10-28T04:29:47Z

docs/environment-setup.md

@@ -123,7 +142,7 @@ _NOTE: This will not work on WSL (Windows Subsystem for Linux). Use the approach
 1. Get [Docker for Desktop For Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
 1. Docker for Desktop comes with docker-compose installed.

-#### Windows 10 Home, Pro, Enterprise, or Education (Insiders / WSL 2 / Docker)
+#### Windows 10 Home, Pro, Enterprise, or Education or Windows 11 (Insiders / WSL 2 / Docker)


Probably want to add a comma after, "Education", here

tpmai22 · 2021-10-28T14:20:53Z

@cindyledev Prefer #2375, would you mind to review if my PR is still needed or anything you want me to change so it can be clear to the other contributors

docs/environment-setup.md

Grommers00

Looks good!

humphd

One change (remove 2. and the code example). Rest looks good.

humphd · 2021-10-29T17:36:15Z

docs/environment-setup.md

+sudo apt upgrade
+```
+
+2. Depending on the distribution you chose for WSL2, install redis using that distro's package manager. You can check your distro's package manager [here](https://www.tecmint.com/linux-distro-for-power-users/). The two most common package manager are APT and DNF.


I don't think we should suggest this. Since we run it all in Docker now, confusing people by having different ways of dealing with Redis seems like a bad idea. If someone understands how to do this, let them do it; but let's not guide new devs to do this.

Grommers00 · 2021-10-31T16:46:42Z

Just gotta rebase it and we can merge :D

tpmai22 · 2021-10-31T17:02:22Z

@Grommers00 I just rebase my commit with the lastest commit on the master

vercel bot deployed to Preview October 26, 2021 23:07 View deployment

humphd requested changes Oct 26, 2021

View reviewed changes

tpmai22 force-pushed the doc-changings branch from 0afef6a to ea0f090 Compare October 27, 2021 04:22

vercel bot deployed to Preview October 27, 2021 04:22 View deployment

tpmai22 force-pushed the doc-changings branch from ea0f090 to 2a25369 Compare October 27, 2021 04:50

vercel bot deployed to Preview October 27, 2021 04:50 View deployment

tpmai22 changed the title ~~Adding sugestions in environment-setup.md~~ Adding sugestions to install WSL2 and it packages in environment-setup.md Oct 27, 2021

Grommers00 requested changes Oct 27, 2021

View reviewed changes

tpmai22 force-pushed the doc-changings branch from 2a25369 to 77d1d0e Compare October 27, 2021 19:05

vercel bot deployed to Preview October 27, 2021 19:05 View deployment

tpmai22 force-pushed the doc-changings branch from 77d1d0e to d9ef384 Compare October 27, 2021 19:56

vercel bot deployed to Preview October 27, 2021 19:56 View deployment

manekenpix assigned tpmai22 Oct 27, 2021

manekenpix added type: documentation (docs) Improvements or additions to documentation hacktoberfest-accepted labels Oct 27, 2021

tpmai22 force-pushed the doc-changings branch from d9ef384 to 8c36004 Compare October 28, 2021 01:14

vercel bot deployed to Preview October 28, 2021 01:14 View deployment

HyperTHD reviewed Oct 28, 2021

View reviewed changes

tpmai22 force-pushed the doc-changings branch from 8c36004 to 8c49c90 Compare October 28, 2021 14:17

vercel bot deployed to Preview October 28, 2021 14:17 View deployment

Grommers00 requested changes Oct 28, 2021

View reviewed changes

docs/environment-setup.md Outdated Show resolved Hide resolved

tpmai22 force-pushed the doc-changings branch from 8c49c90 to 4ad9795 Compare October 28, 2021 22:03

vercel bot deployed to Preview October 28, 2021 22:03 View deployment

tpmai22 force-pushed the doc-changings branch from 4ad9795 to f1912a0 Compare October 28, 2021 22:09

vercel bot deployed to Preview October 28, 2021 22:09 View deployment

humphd requested review from HyperTHD and Grommers00 October 29, 2021 16:02

humphd requested a review from cindyorangis October 29, 2021 16:02

Grommers00 previously approved these changes Oct 29, 2021

View reviewed changes

humphd requested changes Oct 29, 2021

View reviewed changes

tpmai22 dismissed Grommers00’s stale review via e410e34 October 31, 2021 04:06

tpmai22 force-pushed the doc-changings branch from f1912a0 to e410e34 Compare October 31, 2021 04:06

vercel bot deployed to Preview October 31, 2021 04:06 View deployment

humphd previously approved these changes Oct 31, 2021

View reviewed changes

humphd requested a review from Grommers00 October 31, 2021 13:34

Grommers00 previously approved these changes Oct 31, 2021

View reviewed changes

Instruction to install WSL2

0bb62e4

tpmai22 dismissed stale reviews from Grommers00 and humphd via 0bb62e4 October 31, 2021 17:00

tpmai22 force-pushed the doc-changings branch from e410e34 to 0bb62e4 Compare October 31, 2021 17:00

vercel bot deployed to Preview October 31, 2021 17:00 View deployment

Grommers00 self-requested a review October 31, 2021 17:04

Grommers00 approved these changes Oct 31, 2021

View reviewed changes

humphd approved these changes Oct 31, 2021

View reviewed changes

humphd merged commit 74e4787 into Seneca-CDOT:master Oct 31, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding sugestions to install WSL2 and it packages in environment-setup.md #2400

Adding sugestions to install WSL2 and it packages in environment-setup.md #2400

tpmai22 commented Oct 26, 2021

humphd Oct 26, 2021

humphd Oct 26, 2021

tpmai22 Oct 27, 2021

Grommers00 Oct 27, 2021

Grommers00 Oct 27, 2021

tpmai22 Oct 27, 2021

Grommers00 Oct 27, 2021

tpmai22 Oct 28, 2021

HyperTHD Oct 28, 2021

tpmai22 commented Oct 28, 2021

Grommers00 left a comment

humphd left a comment

humphd Oct 29, 2021

tpmai22 Oct 31, 2021

Grommers00 commented Oct 31, 2021

tpmai22 commented Oct 31, 2021

		3. Suggest to install [Windows Terminal](https://docs.microsoft.com/en-us/windows/wsl/install-win10#install-windows-terminal-optional), it facilitates you to switch directories between WSL2 Ubuntu bash and Windows drive
		4. Suggest to install [Node for WSL2](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl), so you can type node cml using WSL2 terminal

Adding sugestions to install WSL2 and it packages in environment-setup.md #2400

Adding sugestions to install WSL2 and it packages in environment-setup.md #2400

Conversation

tpmai22 commented Oct 26, 2021

Issue This PR Addresses

Type of Change

Description

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tpmai22 commented Oct 28, 2021

Grommers00 left a comment

Choose a reason for hiding this comment

humphd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Grommers00 commented Oct 31, 2021

tpmai22 commented Oct 31, 2021